Do some rustdoc cleanups #1357
Merged
Do some rustdoc cleanups #1357
Conversation
This file contains 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
|
Thanks for the review @Kixunil, I've added "do follow up PR" to my todo list. |
tcharding
force-pushed
the
10-31-cleanups
branch
from
d9d1d84
to
6c1a915
Compare
|
Rebased to pick up recent clippy fixes. Added an additional patch containing a bunch of improvements as suggested in the review above. |
Kixunil
reviewed
Nov 5, 2022
So as not to force rebasing onto others like you mention above :) I believe this PR conflicts with #1323 so I'll let that one go in first. |
tcharding
force-pushed
the
10-31-cleanups
branch
from
a2f6458
to
7ed91bd
Compare
|
Rebased, no other changes. |
apoelstra
previously approved these changes
Nov 7, 2022
tcharding
force-pushed
the
10-31-cleanups
branch
from
7ed91bd
to
e82ee26
Compare
|
Rebased only, no other changes. |
Kixunil
requested changes
Nov 22, 2022
tcharding
force-pushed
the
10-31-cleanups
branch
from
e82ee26
to
9761e4a
Compare
|
Fixed the rebase fail. |
apoelstra
previously approved these changes
Nov 23, 2022
rustdocs should contain a newline to separate the brief description from the rest of long description.
Do an audit of the `blockdata` module and clean up rustdocs.
Reduce the number of lines of code by using a longer column width, 100 as is more-or-less standard in this repo. This patch only changes column width (line length), no other changes.
The comments add no value to the code, remove them.
Do an audit of the `consensus` module and clean up rustdocs.
Recently we (tcharding) do some mechanical improvements to the rustdocs in the `blockdata` module without considering the content. On review a bunch of improvements were suggested. Improve the content of various rustdoc comments in the `blockdata` module. Suggested content came from reviewers, all mistakes are my own :)
In order to really bring the security risks of RBF to peoples attention make the docs more scary.
tcharding
force-pushed
the
10-31-cleanups
branch
from
9761e4a
to
26be9dd
Compare
|
Rebased removing changes to |
Kixunil
approved these changes
Dec 6, 2022
| fn emit_u16(&mut self, v: u16) -> Result<(), io::Error>; | ||
| /// Output a 8-bit uint | ||
| /// Outputs a 8-bit unsigned integer. |
| fn emit_i16(&mut self, v: i16) -> Result<(), io::Error>; | ||
| /// Output a 8-bit int | ||
| /// Outputs a 8-bit signed integer. |
| fn read_i16(&mut self) -> Result<i16, Error>; | ||
| /// Read a 8-bit int | ||
| /// Reads a 8-bit signed integer. |
| fn read_u16(&mut self) -> Result<u16, Error>; | ||
| /// Read a 8-bit uint | ||
| /// Reads a 8-bit unsigned integer. |
Closed
apoelstra
approved these changes
Dec 7, 2022
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.
Put some effort into our documentation, this is all pretty non-controversial. Patches separated to ease review.