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.

Sign up for GitHub

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

Jump to bottom

improve FromZeroes documentation #505

Merged
merged 1 commit into from
Oct 24, 2023
Merged

improve FromZeroes documentation #505

merged 1 commit into from
Oct 24, 2023

Conversation

jswrenn
Copy link
Collaborator

@jswrenn jswrenn commented Oct 13, 2023

This PR does essentially three things:

  1. Provides examples of #[derive(FromZeroes)] being used
  2. Provides examples of using many of FromZeroes's methods.
  3. Separates the documentation of the safety conditions of FromZeroes, from the documentation of how derive(FromZeroes) performs its analysis.

If the model of this PR looks good, I'll also apply it to FromBytes and AsBytes.

@joshlf
Copy link
Member

joshlf commented Oct 13, 2023

Awesome! I'll take a look when I get a chance.

In case it's useful to you, there are some ideas for ways to improve these docs: #288

joshlf
joshlf requested changes Oct 16, 2023
View reviewed changes
Copy link
Member

@joshlf joshlf left a comment

Choose a reason for hiding this comment

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

Love this! Some minor nits, but I think the general approach is the right one.

Also, can you reference #32 in the commit message body? For things that aren't closing an issue, I usually do something like:

Makes progress on #32

src/lib.rs Outdated Show resolved Hide resolved
src/lib.rs Outdated Show resolved Hide resolved
src/lib.rs Outdated Show resolved Hide resolved
src/lib.rs Outdated Show resolved Hide resolved
src/lib.rs Show resolved Hide resolved
src/lib.rs Outdated Show resolved Hide resolved
src/lib.rs Outdated Show resolved Hide resolved
src/lib.rs Outdated Show resolved Hide resolved
src/lib.rs Outdated Show resolved Hide resolved
joshlf
joshlf requested changes Oct 24, 2023
View reviewed changes
src/lib.rs Outdated Show resolved Hide resolved
@joshlf joshlf mentioned this pull request Oct 24, 2023
Open
@jswrenn jswrenn force-pushed the doc-fromzeroes branch 2 times, most recently from 83e1ab9 to 0536740 Compare October 24, 2023 14:07
@jswrenn jswrenn requested a review from joshlf October 24, 2023 14:08
joshlf
joshlf requested changes Oct 24, 2023
View reviewed changes
Copy link
Member

@joshlf joshlf left a comment

Choose a reason for hiding this comment

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

Can you also bump the version to 0.7.12 so I can release these docs?

@joshlf joshlf mentioned this pull request Oct 24, 2023
Merged
2 tasks
@jswrenn
[doc] improve FromZeroes documentation
23f9e5f 
This PR adds examples to most methods of `FromZeroes`, and
separately documents `derive(FromZeroes)`. Theoretical soundness
requirements are placed with trait documentation, and the details
of the derive's analysis is placed in the derive documentation.
@jswrenn
Copy link
Collaborator Author

jswrenn commented Oct 24, 2023

Done!

@jswrenn jswrenn requested a review from joshlf October 24, 2023 15:29
@jswrenn jswrenn added this pull request to the merge queue Oct 24, 2023
Merged via the queue into main with commit 7e80f7d Oct 24, 2023
126 checks passed
@jswrenn jswrenn deleted the doc-fromzeroes branch October 24, 2023 15:52
jswrenn added a commit that referenced this pull request Nov 29, 2023
@jswrenn
Improve FromBytes documentation
846fba0 
This PR adds examples to most methods of `FromBytes`, and
separately documents `derive(FromBytes)`. Theoretical soundness
requirements are placed with trait documentation, and the details
of the derive's analysis is placed in the derive documentation.

This PR follows the pattern of #505.
@jswrenn jswrenn mentioned this pull request Nov 29, 2023
Merged
jswrenn added a commit that referenced this pull request Nov 30, 2023
@jswrenn
Improve FromBytes documentation
bd76510 
This PR adds examples to most methods of `FromBytes`, and
separately documents `derive(FromBytes)`. Theoretical soundness
requirements are placed with trait documentation, and the details
of the derive's analysis is placed in the derive documentation.

This PR follows the pattern of #505.

Makes progress towards #32.
jswrenn added a commit that referenced this pull request Nov 30, 2023
@jswrenn
Improve FromBytes documentation
13493f2 
This PR adds examples to most methods of `FromBytes`, and
separately documents `derive(FromBytes)`. Theoretical soundness
requirements are placed with trait documentation, and the details
of the derive's analysis is placed in the derive documentation.

This PR follows the pattern of #505.

Makes progress towards #32.
jswrenn added a commit that referenced this pull request Nov 30, 2023
@jswrenn
Improve FromBytes documentation and release 0.7.27
6958627 
This PR adds examples to most methods of `FromBytes`, and
separately documents `derive(FromBytes)`. Theoretical soundness
requirements are placed with trait documentation, and the details
of the derive's analysis is placed in the derive documentation.

This PR follows the pattern of #505.

Makes progress towards #32.
github-merge-queue bot pushed a commit that referenced this pull request Nov 30, 2023
@jswrenn
Improve FromBytes documentation and release 0.7.27 (#658)
b20a583 
This PR adds examples to most methods of `FromBytes`, and
separately documents `derive(FromBytes)`. Theoretical soundness
requirements are placed with trait documentation, and the details
of the derive's analysis is placed in the derive documentation.

This PR follows the pattern of #505.

Makes progress towards #32.
jswrenn added a commit that referenced this pull request Nov 30, 2023
@jswrenn
Improve AsBytes documentation
eafd9fd 
This PR adds examples to most methods of `AsBytes`, and
separately documents `derive(AsBytes)`. Theoretical soundness
requirements are placed with trait documentation, and the details
of the derive's analysis is placed in the derive documentation.

This PR follows the pattern of #505.

Makes progress towards #32.
@jswrenn jswrenn mentioned this pull request Nov 30, 2023
Merged
jswrenn added a commit that referenced this pull request Nov 30, 2023
@jswrenn
Improve AsBytes documentation
2102182 
This PR adds examples to most methods of `AsBytes`, and
separately documents `derive(AsBytes)`. Theoretical soundness
requirements are placed with trait documentation, and the details
of the derive's analysis is placed in the derive documentation.

This PR follows the pattern of #505.

Makes progress towards #32.
jswrenn added a commit that referenced this pull request Nov 30, 2023
@jswrenn
Improve AsBytes documentation
ee78ae8 
This PR adds examples to most methods of `AsBytes`, and
separately documents `derive(AsBytes)`. Theoretical soundness
requirements are placed with trait documentation, and the details
of the derive's analysis is placed in the derive documentation.

This PR follows the pattern of #505.

Makes progress towards #32.
jswrenn added a commit that referenced this pull request Nov 30, 2023
@jswrenn
Improve AsBytes documentation
1590376 
This PR adds examples to most methods of `AsBytes`, and
separately documents `derive(AsBytes)`. Theoretical soundness
requirements are placed with trait documentation, and the details
of the derive's analysis is placed in the derive documentation.

This PR follows the pattern of #505.

Makes progress towards #32.
jswrenn added a commit that referenced this pull request Nov 30, 2023
@jswrenn
Improve AsBytes documentation
3d0eb51 
This PR adds examples to most methods of `AsBytes`, and
separately documents `derive(AsBytes)`. Theoretical soundness
requirements are placed with trait documentation, and the details
of the derive's analysis is placed in the derive documentation.

This PR follows the pattern of #505.

Makes progress towards #32.
github-merge-queue bot pushed a commit that referenced this pull request Nov 30, 2023
@jswrenn
Improve AsBytes documentation (#660)
b964747 
This PR adds examples to most methods of `AsBytes`, and
separately documents `derive(AsBytes)`. Theoretical soundness
requirements are placed with trait documentation, and the details
of the derive's analysis is placed in the derive documentation.

This PR follows the pattern of #505.

Makes progress towards #32.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@joshlf joshlf joshlf approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jswrenn @joshlf