docs updates - #2141
Draft
heckj wants to merge 32 commits into
Draft
Conversation
…buf for shorthand
…istently across markdown docs
…ntly updated source of truth, filling in missing section in API.md in Documentation/
Collaborator
|
This looks great! |
…voice to break things
A handful of files still had their file-level header block (the description sandwiched between the license separators) written as /// instead of //, unlike the rest of the codebase.
Passive constructions throughout the /// doc comments and DocC markdown prose left the actor unclear or buried in a "by ..." clause. Rewrites these as simple, direct, active-voice sentences with the generator, decoder, encoder, or caller named as the subject.
…nd consolidating examples for using the plugins to use an older, but clearly existing, version
…he discussion/overview below
…f types into narrative english prose
Contributor
Author
|
state at the moment, rendered locally: 
In terms of coverage, it's fairly significantly expanded: SwiftProtobuf
Overall abstract coverage: 71% → 84% SwiftProtobufPluginLibrary
Overall abstract coverage: 44% → 54% The main libraries have organiztion/curation for the types to make them easier for someone scanning/reading online as well as through IDEs that expose DocC content/abstracts during development (both Xcode and VSCode with the Swift extension, perhaps others - I only checked the first two) Some of the doc content exposed comes from code generation from upstream sources (the |
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.
Broad sweep of documentation cleanup