Update docstrings for consistency in rendered API#173
Merged
stefanvanburen merged 4 commits intomainfrom Mar 18, 2026
Merged
Conversation
Just a first pass at improving the rendering of some of these, based on the review I gave. Effectively: * Add periods consistently * Add some links * Mention generated code for endpoints (this maybe could be extended further?) * Make a couple docstrings more consistent with others I also noticed while iterating on this locally that `zensical serve` does not seem to consistently cache-bust when changing these docstrings; for now, I'm just wiping the cache as a part of the justfile target, and am planning to report upstream. Ref: #172 (review) Signed-off-by: Stefan VanBuren <svanburen@buf.build>
4 tasks
Signed-off-by: Stefan VanBuren <svanburen@buf.build>
Signed-off-by: Stefan VanBuren <svanburen@buf.build>
Also improves a type hint for `_default_compressions` that was firing in my $EDITOR. Ref: zensical/zensical#451 (comment) Signed-off-by: Stefan VanBuren <svanburen@buf.build>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Just a first pass at improving the rendering of some of these, based on the review I gave.
Effectively:
I also noticed while iterating on this locally that
zensical servedoes not seem to consistently cache-bust when changing these docstrings; for now, I'm just wiping the cache as a part of the justfile target, and am planning to report upstream.Ref: #172 (review)