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

Deny missing docs in runtime core and add missing docs #942

Merged
merged 8 commits into from
Nov 10, 2019

Conversation

bjfish
Copy link
Contributor

@bjfish bjfish commented Nov 10, 2019

Description

Deny missing docs in runtime core and add missing docs

Review

  • Add a short description of the the change to the CHANGELOG.md file

@bjfish bjfish requested a review from Hywan as a code owner November 10, 2019 19:14
Copy link
Contributor

@nlewycky nlewycky left a comment

Choose a reason for hiding this comment

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

Thank you so much for doing this!!

The comments I've left may all be addressed post-commit.

lib/runtime-core/src/error.rs Show resolved Hide resolved
#[repr(u8)]
#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub enum GPR {
/// RAX Register
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a way to suppress the extra comments here? These aren't adding value, and they're doubling the number of lines.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@nlewycky They can be suppressed individually using #[doc(hidden)] but that would be the same number of lines. I think they would all be suppressed with #[doc(hidden)] on the enum but then we wouldn't get a doc for that.

lib/runtime-core/src/sys/unix/memory.rs Outdated Show resolved Hide resolved
lib/runtime-core/src/vm.rs Outdated Show resolved Hide resolved
@bjfish
Copy link
Contributor Author

bjfish commented Nov 10, 2019

bors try

bors bot added a commit that referenced this pull request Nov 10, 2019
@bjfish
Copy link
Contributor Author

bjfish commented Nov 10, 2019

bors try

@bors
Copy link
Contributor

bors bot commented Nov 10, 2019

try

Already running a review

@bors
Copy link
Contributor

bors bot commented Nov 10, 2019

try

Build failed

  • wasmerio.wasmer

@bjfish
Copy link
Contributor Author

bjfish commented Nov 10, 2019

bors r+

bors bot added a commit that referenced this pull request Nov 10, 2019
942: Deny missing docs in runtime core and add missing docs r=bjfish a=bjfish

<!-- 
Prior to submitting a PR, review the CONTRIBUTING.md document for recommendations on how to test:
https://github.com/wasmerio/wasmer/blob/master/CONTRIBUTING.md#pull-requests

-->

# Description
Deny missing docs in runtime core and add missing docs
<!-- 
Provide details regarding the change including motivation,
links to related issues, and the context of the PR.
-->

# Review

- [x] Add a short description of the the change to the CHANGELOG.md file


Co-authored-by: Brandon Fish <[email protected]>
@bors
Copy link
Contributor

bors bot commented Nov 10, 2019

Canceled

@bjfish
Copy link
Contributor Author

bjfish commented Nov 10, 2019

bors r+

bors bot added a commit that referenced this pull request Nov 10, 2019
942: Deny missing docs in runtime core and add missing docs r=bjfish a=bjfish

<!-- 
Prior to submitting a PR, review the CONTRIBUTING.md document for recommendations on how to test:
https://github.com/wasmerio/wasmer/blob/master/CONTRIBUTING.md#pull-requests

-->

# Description
Deny missing docs in runtime core and add missing docs
<!-- 
Provide details regarding the change including motivation,
links to related issues, and the context of the PR.
-->

# Review

- [x] Add a short description of the the change to the CHANGELOG.md file


Co-authored-by: Brandon Fish <[email protected]>
@bors
Copy link
Contributor

bors bot commented Nov 10, 2019

Build succeeded

  • wasmerio.wasmer

@bors bors bot merged commit a74acb7 into master Nov 10, 2019
@bors bors bot deleted the feature/runtime-core-deny-missing-docs branch November 10, 2019 23:02
@Hywan
Copy link
Contributor

Hywan commented Nov 11, 2019

👏

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.

3 participants