Add doc links throughout our user-facing APIs #1239
Merged
Conversation
This file contains 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
tdeebswihart
force-pushed
the
add-links-to-godoc
branch
2 times, most recently
from
4443bee to
281efbb
Compare
Not necessarily true (many times that's the only way we can document struct fields). But this LGTM, feel free to merge at will or let us know if it won't let you. |
Quinn-With-Two-Ns
approved these changes
Sep 18, 2023
Yeah, I'm used to those being internal only so skipped them out of habit. If missing docs still bothers me I'll take a swing at those too |
Backfill doc links throughout our user-facing APIs. I didn't touch the internal package as those aren't supposed to be for external consumption. While here I cleaned up a few things, like adding links to referenced code samples and removing a doc comment in a spot where they're unsupported; you can't add links in the comments on interface methods or struct members.
tdeebswihart
force-pushed
the
add-links-to-godoc
branch
from
281efbb to
eafcf31
Compare
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.
What was changed
I backfilled doc links throughout our user-facing APIs. I didn't touch the internal package as those aren't supposed to be for external consumption.
While here I cleaned up a few things, like adding links to referenced code samples and removing a doc comment in a spot where they're unsupported; you can't add links in the comments on interface methods or struct members.
Why?
Linking readers to referenced APIs saves them time when trying to understand how to use temporal.
Checklist
This was tested by running godoc locally and inspecting the rendered docs. Note that cross-package doc links still don't work so cannot be verified locally.