Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Format specs #5857

Merged
merged 9 commits into from Apr 29, 2022
Merged

[DOC] Format specs #5857

merged 9 commits into from Apr 29, 2022

Conversation

BurdetteLamar
Copy link
Member

This new document would eventually replace the format spec discussion at Kernel#sprintf, which would then link to the new doc.

One of the aims here is to make the discussion of a type specifier, say %b, sufficient in itself, without the reader having to carry a lot of info from other sections. In this beginning, only the one type specifier is detailed; others will follow in new PRs.

@BurdetteLamar BurdetteLamar added the Documentation Improvements to documentation. label Apr 28, 2022
Copy link
Contributor

@jeremyevans jeremyevans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See inline responses. Note that pushing additional commits after asking for a review can make review more difficult.

doc/kernel/format_specifications.rdoc Outdated Show resolved Hide resolved
doc/kernel/format_specifications.rdoc Outdated Show resolved Hide resolved
doc/kernel/format_specifications.rdoc Outdated Show resolved Hide resolved
doc/kernel/format_specifications.rdoc Outdated Show resolved Hide resolved
doc/kernel/format_specifications.rdoc Outdated Show resolved Hide resolved
doc/kernel/format_specifications.rdoc Outdated Show resolved Hide resolved
doc/kernel/format_specifications.rdoc Outdated Show resolved Hide resolved
doc/kernel/format_specifications.rdoc Outdated Show resolved Hide resolved
@BurdetteLamar
Copy link
Member Author

Note that pushing additional commits after asking for a review can make review more difficult.

Sorry. I failed to resist the temptation to plug holes and correct errors. Will do better.

@BurdetteLamar
Copy link
Member Author

I'm re-opening this because I really really want to see improvement to the doc for format specs.

I'll correct the errors cited by @jeremyevans, and seek common ground about the way the types should be documented.

@BurdetteLamar BurdetteLamar reopened this Apr 29, 2022
@BurdetteLamar
Copy link
Member Author

@jeremyevans, let's try for common ground on b and B.

doc/kernel/format_specifications.rdoc Outdated Show resolved Hide resolved
doc/kernel/format_specifications.rdoc Outdated Show resolved Hide resolved
doc/kernel/format_specifications.rdoc Outdated Show resolved Hide resolved
doc/kernel/format_specifications.rdoc Outdated Show resolved Hide resolved
@BurdetteLamar
Copy link
Member Author

@jeremyevans, I'd originally thought to include this file in kernel.c, but later realized that it'll be better as a free-standing doc that all 4 *printf methods can link to. Therefore should be in doc/ not doc/kernel? If so, should the move be before this merge, or after?

@BurdetteLamar
Copy link
Member Author

@jeremyevans Oh, and what about the many to-be-supplied sections? Keep adding to this PR, reviewing as we go? Or merge and add later?

@jeremyevans
Copy link
Contributor

@jeremyevans, I'd originally thought to include this file in kernel.c, but later realized that it'll be better as a free-standing doc that all 4 *printf methods can link to. Therefore should be in doc/ not doc/kernel? If so, should the move be before this merge, or after?

Let's move to doc/ before the merge.

@jeremyevans Oh, and what about the many to-be-supplied sections? Keep adding to this PR, reviewing as we go? Or merge and add later?

Let's merge this after the move to doc/, then you can work on other specifiers.

@BurdetteLamar
Copy link
Member Author

@jeremyevans, all set? I've removed the addition (kernel) to doc/.document.

@BurdetteLamar BurdetteLamar merged commit 7c039e4 into ruby:master Apr 29, 2022
schneems pushed a commit to schneems/ruby that referenced this pull request May 23, 2022
This new document would eventually replace the format spec discussion at Kernel#sprintf.
schneems pushed a commit to schneems/ruby that referenced this pull request Jul 26, 2022
This new document would eventually replace the format spec discussion at Kernel#sprintf.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements to documentation.
2 participants