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

Missing documents/comments for public items #309

Closed
qinsoon opened this issue May 11, 2021 · 1 comment · Fixed by #1028
Closed

Missing documents/comments for public items #309

qinsoon opened this issue May 11, 2021 · 1 comment · Fixed by #1028
Labels
A-general Area: all code base (issues with this label may be divided into more concrete issues) C-missing Category: Missing stuff that should be added
Milestone
1.0 Release

Comments

@qinsoon
Copy link
Member

qinsoon commented May 11, 2021

For documentation, a first step we can do is to add missing documents for our public types and functions. We can enforce documents with rustdoc's missing_docs lints, which requires all public items to be documented. Once #241 is done, we should then only expose a limited number of public items.
@qinsoon qinsoon added A-general Area: all code base (issues with this label may be divided into more concrete issues) C-missing Category: Missing stuff that should be added labels May 11, 2021
@qinsoon qinsoon added this to the 1.0 Release milestone Oct 29, 2021
@qinsoon
Copy link
Member Author

qinsoon commented Nov 10, 2023

We currently have 368 public items that do not have comments. I plan to add comments for them, and also check if those items really should be public. I probably will submit one PR for every 50 changes or so. The PRs should be removing pub for some items, and adding missing comments.

@qinsoon qinsoon mentioned this issue Nov 11, 2023
Merged
github-merge-queue bot pushed a commit that referenced this issue Nov 14, 2023
@qinsoon
Add missing docs for the vm module (#1021)
2d5bae7 
This PR is a step towards #309.
* Add some tests and documents to clarify `HeaderMetadata.bit_offset`
(related discussion:
https://mmtk.zulipchat.com/#narrow/stream/315620-Porting/topic/ScalaNative.2FMMTK/near/398587245).
* Modify the macro `define_vm_metadata_spec!` to allow adding docs for
the generated types.
* Add missing docs for public items in the `vm` module.

Please feel free to make edits to the PR if there is any issue.
@qinsoon qinsoon mentioned this issue Nov 14, 2023
Merged
github-merge-queue bot pushed a commit that referenced this issue Nov 16, 2023
@qinsoon
Add missing docs for some util modules (#1024)
9786ce8 
This PR is a step towards #309.
* Add missing docs for some `util` modules.
* Make `util::metadata::side_metadata::helpers/helpers_32` not public.
* Make `util::reference_processor` not public.
* Allow adding docs for options defined by the `options!` macro.
This was referenced Nov 16, 2023
Merged
Merged
github-merge-queue bot pushed a commit that referenced this issue Nov 22, 2023
@qinsoon
Add missing docs for the rest of the util module (#1026)
b066199 
This PR is a step towards #309.
* Deny `missing_docs` for the `util` module and the `vm` module.
* Change some items from `pub` to `pub(crate)`.
* Remove some unused constants.
github-merge-queue bot pushed a commit that referenced this issue Nov 23, 2023
@qinsoon
Add missing docs for the rest of the code base (merge after #1026) (#…
a87636c 
…1028)

This is the last PR for adding missing docs, and it closes
#309. All the public items
should be documented properly now, and `#![deny(missing_docs)]` is used
so any new public item that does not have rustdoc will cause the build
to fail.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-general Area: all code base (issues with this label may be divided into more concrete issues) C-missing Category: Missing stuff that should be added
Projects
None yet
Milestone
1.0 Release
Development

Successfully merging a pull request may close this issue.

Add missing docs for the rest of the code base (merge after #1026) qinsoon/mmtk-core
1 participant
@qinsoon