Docs: Love! Linking, fixes, code formatting, etc. by NickCraver · Pull Request #2100 · StackExchange/StackExchange.Redis (original) (raw)
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 andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Conversation2 Commits3 Checks0 Files changed
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
[ Show hidden characters]({{ revealButtonHref }})
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 ` 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.
This iterates on docs a bit. Once noticing 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?
@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
NickCraver added a commit that referenced this pull request
Reverts #2100
This was aimed to be merged after #2098 landed, my fault. Reverting out for that to happen.
NickCraver added a commit that referenced this pull request
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 ` 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.