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

Refactor user-guide of book #529

Merged
merged 5 commits into from
Jul 15, 2021
Merged

Refactor user-guide of book #529

merged 5 commits into from
Jul 15, 2021

Conversation

Urhengulas
Copy link
Member

@Urhengulas Urhengulas commented Jul 11, 2021

This PR aims to update the user guide of the book to the dirbaio PRs and is doing quite some refactoring on the side.

Preview: https://deploy-preview-529--admiring-dubinsky-56dff5.netlify.app

@Urhengulas Urhengulas changed the title Refactor book Refactor user-guide of book Jul 13, 2021
* `setup`: Deduplicate setup
* `setup-app`: name `cargo.toml`; add `defmt-itm`
* `macros`: Language
* `primitives`: Table-ize and drop `u24` (got dropped in (#521))
* `str`: Add links to doc-rs
* ...
@Urhengulas Urhengulas marked this pull request as ready for review July 13, 2021 13:20
@japaric japaric self-requested a review July 14, 2021 14:26
Copy link
Member

@japaric japaric left a comment

Choose a reason for hiding this comment

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

I love the visual changes with the use of blockquotes and emoji. 👍

I left several inline comments but otherwise this looks good to me. Feel free to send this to bors after addressing my comments / suggestions

book/src/setup.md Outdated Show resolved Hide resolved
book/src/setup-app.md Outdated Show resolved Hide resolved
book/src/setup-app.md Outdated Show resolved Hide resolved
book/src/macros.md Outdated Show resolved Hide resolved
book/src/macros.md Outdated Show resolved Hide resolved
book/src/bitfields.md Outdated Show resolved Hide resolved
book/src/bitfields.md Show resolved Hide resolved
When the alternate form is used for hex and binary, the `0x`/`0b` length is subtracted from the
leading zeros. This matches [`core::fmt` behavior](https://play.rust-lang.org/?version=stable&mode=debug&edition=2018&gist=b11809759f975e266251f7968e542756). No further
customization is supported (at the moment).
## Alternate printing
Copy link
Member

Choose a reason for hiding this comment

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

could you include in this section that {}, "hello" is formatted as hello but that {:#}, "hello" is formatted as "hello" and note that this matches core::fmt behavior

Copy link
Member Author

Choose a reason for hiding this comment

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

I guess you mean {:?}? I am generally unsure what the ? does anyways, since we don't have separate Debug formatting.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll merge it without this being resolved and will raise the question in zulip :)

book/src/global-logger.md Outdated Show resolved Hide resolved
book/src/global-logger.md Outdated Show resolved Hide resolved
@Urhengulas
Copy link
Member Author

bors r+

@bors
Copy link
Contributor

bors bot commented Jul 15, 2021

Build succeeded:

@bors bors bot merged commit 09278af into main Jul 15, 2021
@bors bors bot deleted the refactor-book branch July 15, 2021 22:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants