Idiomatic: Various minor tweaks to doc comments section#3162
Merged
mgeisler merged 3 commits intogoogle:mainfrom Apr 28, 2026
Merged
Idiomatic: Various minor tweaks to doc comments section#3162mgeisler merged 3 commits intogoogle:mainfrom
mgeisler merged 3 commits intogoogle:mainfrom
Conversation
mgeisler
reviewed
Apr 20, 2026
mgeisler
approved these changes
Apr 20, 2026
…ibrary-vs-application-docs.md
auto-merge was automatically disabled
April 21, 2026 20:06
Head branch was pushed to by a user without write access
mgeisler
approved these changes
Apr 28, 2026
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.
Various minor tweaks to the "Meaningful Doc Comments" section of Idiomatic based on my experience teaching the class for the first time.
anatomy-of-a-doc-comment.md- Reorder speaker note so the Q&A about panics is organized under the section about panics.what-why-not-how-where.md- Remove thesort_quicklyexample. This is later used as the example in the exercise, and I think discussing it before the exercise undercuts the value of the exercise.