docs: Format entrypoint documentation
#214
Merged
Conversation
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
joncinque
reviewed
Jul 29, 2025
Collaborator
joncinque
left a comment
joncinque
left a comment
There was a problem hiding this comment.
Looks good to me! Just a couple of small things.
We should be able to enforce this with https://github.com/rust-lang/rustfmt/blob/master/Configurations.md#comment_width, no? Pinocchio just doesn't have a rustfmt.toml like Agave or the SDK
As for the blame skip, I'm not too fussed about it personally.
Format doc-comments and comment to be 100 characters wide. Use quotes when referencing feature names. `` `"std"` feature ``, rather than `` "`std`" feature ``, or `` `std` feature ``. This seems to be the common convention. Also added a few automatic links in the doc comments, where previously it was just quoted name of a type.
ilya-bobyr
force-pushed
the
pr/docs-entrypoint-format
branch
from
6511483 to
3e01692
Compare
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.
Format doc-comments and comment to be 100 characters wide.
Use quotes when referencing feature names.
`"no_std"` feature, rather than"`no_std`" feature, or`no_std` feature.This seems to be the common convention.
Also added a few automatic links in the doc comments, where previously it was just quoted name of a type.
Not sure what do you guys think about this kind of changes.
Some people call it "churn" and do not accept them.
I personally think that it would be much better if these things would be automatically enforced, similar to how
fmtdeals with many other formatting details.But it does not seem like it can do it.
If merged, I would next add a
.git-blame-ignore-revsand add this commit SHA in there.GitHub will pick it up automatically:
https://docs.github.com/en/repositories/working-with-files/using-files/viewing-and-understanding-files#ignore-commits-in-the-blame-view
Git in general will require a bit of manual configuration, but it seems to be a pretty common approach:
https://git-scm.com/docs/git-blame#Documentation/git-blame.txt---ignore-revs-filefile