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

Add lots of rustdocs and clean up one line of code #841

Merged
merged 3 commits into from
Sep 27, 2019
Merged

Add lots of rustdocs and clean up one line of code #841

merged 3 commits into from
Sep 27, 2019

Conversation

MarkMcCaskey
Copy link
Contributor

@MarkMcCaskey MarkMcCaskey commented Sep 27, 2019 •
edited
Loading

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

@MarkMcCaskey MarkMcCaskey added the 📚 documentation Do you like to read? label Sep 27, 2019
@MarkMcCaskey MarkMcCaskey force-pushed the docs/improved-rust-docs branch from 1687ea6 to dc17445 Compare September 27, 2019 00:18
nlewycky
nlewycky reviewed Sep 27, 2019
View reviewed changes
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.

Sentences should end with a full stop.

lib/runtime/src/lib.rs Outdated
@@ -189,6 +189,10 @@ pub fn instantiate(wasm: &[u8], import_object: &ImportObject) -> error::Result<I
}

/// Get a single instance of the default compiler to use.
///
/// The ouptput of this function can be controlled by the mutually
Copy link
Contributor

Choose a reason for hiding this comment

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

Type: ouptput --> output

lib/runtime/src/lib.rs Outdated
@@ -219,6 +223,11 @@ pub fn default_compiler() -> impl Compiler {
DefaultCompiler::new()
}

/// Get the `Compiler` as a trait object for the given `Backend`.
/// Returns `Option` because support for the `Compiler` may not be enabled by
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion: ... support for the requested Compiler ...

lib/wasi/src/state/mod.rs Outdated
@@ -44,6 +55,7 @@ pub struct InodeVal {
pub kind: Kind,
}

/// The core file-object data type
Copy link
Contributor

Choose a reason for hiding this comment

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

'core file-object' doesn't help me distinguish it from other "file" data types. Is it a file descriptor or some sort of handle? Or the part that holds the file's contents?

@MarkMcCaskey
Copy link
Contributor Author

bors r+

bors bot added a commit that referenced this pull request Sep 27, 2019
@bors
Merge #841
67ae86b 
841: Add lots of rustdocs and clean up one line of code r=MarkMcCaskey a=MarkMcCaskey



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


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

bors bot commented Sep 27, 2019

Build succeeded

  • wasmerio.wasmer

@bors bors bot merged commit dad43dd into master Sep 27, 2019
@bors bors bot deleted the docs/improved-rust-docs branch September 27, 2019 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nlewycky nlewycky nlewycky left review comments

@syrusakbary syrusakbary syrusakbary approved these changes

@bjfish bjfish Awaiting requested review from bjfish

@Hywan Hywan Awaiting requested review from Hywan

Assignees
No one assigned
Labels
📚 documentation Do you like to read?
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@MarkMcCaskey @syrusakbary @nlewycky