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

Add must_use to std docs #583

Merged
merged 6 commits into from
Feb 5, 2024
Merged

Conversation

Midnightific
Copy link
Contributor

Closes: #407

Adds must_use functionality and documentation for std docs.

Std documentation now has `must_use` functionality with the appropriate example
@Midnightific Midnightific changed the title 📃 docs(std): Add must_use Add must_use to std docs Jan 24, 2024
docs/src/usage/std.md Outdated Show resolved Hide resolved
docs/src/usage/std.md Outdated Show resolved Hide resolved
docs/src/usage/std.md Outdated Show resolved Hide resolved
`false` is now appropriately labelled as the default value of `must_use`.

Resolves: Kampfkarren#583 (comment)
`must_use` has its own example while `observes` and `required` have their respective example
docs/src/usage/std.md Outdated Show resolved Hide resolved
docs/src/usage/std.md Outdated Show resolved Hide resolved
The default option is now displayed correctly

Resolves: Kampfkarren#583 (comment)
Replaced `table.find` example with a `tostring` example

Resolves: Kampfkarren#583 (comment)
@Midnightific
Copy link
Contributor Author

@Kampfkarren Are you able to take a look at this?

@Kampfkarren Kampfkarren merged commit 231ad62 into Kampfkarren:main Feb 5, 2024
12 checks passed
@Midnightific Midnightific deleted the docs-must_use branch February 5, 2024 10:23
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.

Standard library format docs don't mention must_use
3 participants