console api docs #197
Merged
console api docs #197
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
pnkfelix
force-pushed
the
pnk/console-api-docs
branch
from
58fb4bf to
3a9ec48
Compare
…obuf definition).
pnkfelix
force-pushed
the
pnk/console-api-docs
branch
from
3a9ec48 to
a74c2ce
Compare
hawkw
approved these changes
Dec 15, 2021
| MetaId metadata_id = 8; | ||
| } | ||
|
|
||
| // Represents a period of time in which a program was executing in a particular context. | ||
| // | ||
| // Corresponds to `Span` in the `tracing` crate. |
There was a problem hiding this comment.
it would be really nice if these were links to tracing's docs, but IDK how prost's codegen handles markup in doc comments...so not a big deal if we can't easily make this work.
There was a problem hiding this comment.
yeah my experience trying to add markup links was very bad. It escaped the [ and ] characters (or did so nearly always). So lets side-step this for now.
There was a problem hiding this comment.
sounds good...it would be nice if there was support for that upstream. that might be worth opening a prost ticket.
Thanks hawkw! Co-authored-by: Eliza Weisman <[email protected]>
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.
Part of #194: document public API of the console-api crate.