Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rex fix formatting nits #403

Merged
merged 8 commits into from
Mar 18, 2022

Conversation

RexJaeschke
Copy link
Contributor

@RexJaeschke RexJaeschke commented Nov 18, 2021

@jskeet This one can now be merged.

@jskeet jskeet added meeting: discuss This issue should be discussed at the next TC49-TG2 meeting and removed meeting: discuss This issue should be discussed at the next TC49-TG2 meeting labels Dec 10, 2021
@jskeet
Copy link
Contributor

jskeet commented Dec 15, 2021

Label removed as this is a PR that Rex uses to fix typos periodically.

@RexJaeschke RexJaeschke marked this pull request as ready for review January 18, 2022 18:15
Copy link
Contributor

@jskeet jskeet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly fine, although there are conflicts.

standard/classes.md Outdated Show resolved Hide resolved

An async function has the ability to suspend evaluation by means of await expressions ([§12.8.8](expressions.md#1288-await-expressions)) in its body. Evaluation may later be resumed at the point of the suspending await expression by means of a ***resumption delegate***. The resumption delegate is of type `System.Action`, and when it is invoked, evaluation of the async function invocation will resume from the await expression where it left off. The ***current caller*** of an async function invocation is the original caller if the function invocation has never been suspended or the most recent caller of the resumption delegate otherwise.
An async function has the ability to suspend evaluation by means of await expressions in its body. Evaluation may later be resumed at the point of the suspending await expression by means of a ***resumption delegate***. The resumption delegate is of type `System.Action`, and when it is invoked, evaluation of the async function invocation will resume from the await expression where it left off. The ***current caller*** of an async function invocation is the original caller if the function invocation has never been suspended or the most recent caller of the resumption delegate otherwise.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why have we removed the link here?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When resolving conflicts, I put the link back in. @RexJaeschke Does that make sense to you?

Copy link
Contributor

@jskeet jskeet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's still one comment about link removal, but once that's sorted I'd like to get this merged, to avoid it getting stale. (It's quite old now.) I don't know whether it's already out of date with respect to section references.

standard/classes.md Outdated Show resolved Hide resolved
Copy link
Member

@BillWagner BillWagner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This LGTM.

@RexJaeschke See the one comment from Jon and I regarding removing a link.

Once we're clear there, I'll merge this.

@RexJaeschke
Copy link
Contributor Author

@BillWagner The link you restored looks good, Bill. But the link-verifier failure reported above appears to be in README.md, which is not something I'm touching.

@BillWagner
Copy link
Member

But the link-verifier failure reported above appears to be in README.md, which is not something I'm touching.

We need to fix that in our tooling. The links in the readme are generated by our tool. So, we don't care if they aren't correct when we remove or replace a clause. (The tool will fix it).

I'll work with @Youssef1313 to submit a PR so we can ignore bad links in that file.

@BillWagner BillWagner merged commit 21b8817 into dotnet:draft-v6 Mar 18, 2022
@BillWagner BillWagner deleted the Rex-fix-formatting-nits branch March 18, 2022 15:04
@Youssef1313
Copy link
Member

@BillWagner It looks like you already fixed the failure here in #514. If the workflow was given a re-run, it would have succeeded.

@Youssef1313
Copy link
Member

Just need to make sure the tool that generates README.md doesn't overwrite the change in #514

@BillWagner
Copy link
Member

@Youssef1313 Yes, this condition is self-correcting.

See #484 it reappears every time we add or remove a section, until that PR gets merged, and then the action runs to regenerate the TOC. It's a lower priority, but in time, I'd still like all the PRs to have green CI results.

@Youssef1313
Copy link
Member

Youssef1313 commented Mar 18, 2022

While #514 was a good step in getting CI green. It's possible this fail in the future for characters that are not handled correctly (currently the ellipse was special-cased).

A more stable fix would be to replace this logic:

string anchor = $"{newSectionNumber} {header.title}"
.Replace(' ', '-').Replace(".", "").Replace(",", "").Replace("`", "")
.Replace("/", "").Replace(":", "").Replace("?", "").Replace("&", "")
.Replace("|", "").Replace("!", "").Replace("\\<", "").Replace("\\>", "").Replace("\\#", "")
.Replace("", "")
.ToLower();

with

https://github.com/xoofx/markdig/blob/0cfe6d7da48ea6621072eb50ade32141ea92bc35/src/Markdig/Helpers/LinkHelper.cs#L100-L113

I opened #520

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants