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

Clean up <code> in XML docs #20893

Merged
merged 1 commit into from
May 9, 2020
Merged

Clean up <code> in XML docs #20893

merged 1 commit into from
May 9, 2020

Conversation

roji
Copy link
Member

@roji roji commented May 8, 2020

Closes #20849

@roji roji requested a review from a team May 8, 2020 22:12
/// context.Blogs
/// .Include(blog => blog.Posts).ThenInclude(post => post.Tags).ThenInclude(tag => tag.TagInfo)
/// .Include(blog => blog.Contributors);
/// context.Blogs
Copy link
Member Author

Choose a reason for hiding this comment

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

Not sure about the "right" way to do leading whitespace, but I do know that the current docs look bad.

Maybe @smitpatel knows if we can see a preview for this PR somehow?

Copy link
Contributor

Choose a reason for hiding this comment

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

It is a very long way to generate a preview and probably not possible.

Copy link
Contributor

Choose a reason for hiding this comment

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

Also write context.Blogs on same line as code and new lines offset by 3 spaces from // 🤔

Copy link
Member Author

Choose a reason for hiding this comment

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

The docs for EntityFrameworkServiceCollectionExtensions seem to suggest it's possible to put it not on the same line code, but I got pretty confused by the indentation :/ Should we merge this and see what happens, possibly fix again later? Or are you sure that 3 spaces (!!) is the way to go?

Copy link
Contributor

Choose a reason for hiding this comment

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

I calculated white space count in the source file, generated docs file and parsed website content. If we really care, I can get new APIs published for preview version.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm going to go ahead and merge, but keep this issue to make sure the output is reasonable - let's revisit if otherwise.

@roji roji merged commit daf9cf3 into master May 9, 2020
@roji roji deleted the CodeCodeCode branch May 9, 2020 08:00
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.

Review our usage of <code> in XML docs
3 participants