Add package docs #75
Add package docs #75
Conversation
|
Coming back to this, I think this makes more sense to live in the README. So I'm thinking I should merge this information into the existing information in the readme and add a table of contents at the top of the readme, and adjust the ordering so usage comes first. Wdyt @marten-seemann ? |
|
@MarcoPolo : I know you weren't asking me, but your plan seems reasonable to me. |
|
updated @marten-seemann |
README.md
Outdated
|
|
||
| These errors occur whenever we've hit a limit. For example we'll get this error | ||
| if we are at our limit for the number of streams we can have, and we try to open | ||
| one more. |
There was a problem hiding this comment.
There's an inconsistency between "you" in the other paragraphs and the "we" here. Maybe it's better to use passive voice here: "These errors occur whenever a limit is hit."
There was a problem hiding this comment.
Used the passive voice for the first sentence, then you for the rest of the paragraph.
Typos and adjustments that missed getting into #75
Adds some package docs that will show up in the godoc page. Inspired by the formatting of https://pkg.go.dev/encoding/gob.