-
-
Notifications
You must be signed in to change notification settings - Fork 411
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
Document CodeBlock #1691
Document CodeBlock #1691
Conversation
Hi @TheDoctor314! Thank you for your contribution :) This indeed goes towards the good direction. I see a couple of missing things, though. First, the This PR, in order to fully solve #1609, should also add some documentation to all internal methods where it's missing, such as Furthermore, I would prefer if we could add some extra explanation, like a longer description below what is usually the short description (the first line). And, if we could have some |
Codecov Report
@@ Coverage Diff @@
## main #1691 +/- ##
==========================================
- Coverage 50.91% 50.85% -0.07%
==========================================
Files 199 199
Lines 17707 17803 +96
==========================================
+ Hits 9016 9053 +37
- Misses 8691 8750 +59
Continue to review full report at Codecov.
|
Thanks for the feedback! |
Also fix some typos.
boa/src/vm/code_block.rs
Outdated
#[derive(Debug, Trace, Finalize)] | ||
pub struct CodeBlock { | ||
/// Name of this function | ||
pub(crate) name: JsString, | ||
|
||
// The length of this function. | ||
/// The length of this function. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this the length of arguments this function takes?
Maybe something like this at the top which says. //! CodeBlock
//! This module is for the CodeBlock which implements a function representation in the VM
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
above
@HalidOdat are you able to help explain the need for unsafe readable here? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM but I think we might want to wait for @HalidOdat to say something about the documentation of the unsafe
parts
This Pull Request fixes/closes #1609.
It changes the following: