Docs: Love! Linking, <remarks> fixes, code formatting, etc. #2100
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This iterates on docs a bit. Once noticing <remarks> doesn't render after the first one, I realized we were dropping ref links...and it'd be better if they were clickable. This globally makes them clickable from intellisense hovers.
mgravell
approved these changes
Apr 19, 2022
Collaborator
mgravell
left a comment
mgravell
left a comment
There was a problem hiding this comment.
I was watching you tweet about this over the egg-shaped weekend; very nice
question, though; the LatencyHistory stuff - doesn't seem to be used; is this prep work? side-effect of multiple PRs? I mean... it looks fine, I'm just not sure it is used?
Collaborator
Author
|
@mgravell yep tis used, I didn't remember it either but it's a few commands from IServer and was sitting in IServer.cs so cleaning up there :) |
NickCraver
added a commit
that referenced
this pull request
Apr 19, 2022
NickCraver
added a commit
that referenced
this pull request
Apr 19, 2022
…2109) Repeat of #2100, for after #2071 goes in. This does a few things globally to the interfaces: - De-dupes `<remarks>` since evidently past the first one doesn't count/render - Links our redis command links (and all others) so they're easily clickable! - Moves a few types to proper class files - In places sync/async methods are adjacent, utilizes `<inheritdoc cref="" /> to de-dupe - ...and some other misc URL cleanup throughout. In general: docs only change - I think we should merge this as-is to help PRs coming in, then I'll continue to iterate on docs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This does a few things globally to the interfaces:
<remarks>since evidently past the first one doesn't count/renderIn general: docs only change - I think we should merge this as-is to help PRs coming in, then I'll continue to iterate on docs.