[Merged by Bors] - Documentation Updates #2463
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #2463 +/- ##
==========================================
+ Coverage 52.50% 52.71% +0.20%
==========================================
Files 332 330 -2
Lines 34924 34764 -160
==========================================
- Hits 18338 18326 -12
+ Misses 16586 16438 -148
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
I'd say we should almost always use |
raskad
reviewed
Nov 29, 2022
|
Switched this from draft to review. I tried to make as much of the documentation as consistent as possible. Although, this ended up touching up the wording on a decent amount of files. 😅 |
nekevss
requested review from
jedel1043,
Razican,
HalidOdat and
jasonwilliams
raskad
approved these changes
Dec 2, 2022
Razican
approved these changes
Dec 2, 2022
|
bors r+ |
bors bot
pushed a commit
that referenced
this pull request
Dec 2, 2022
<!--- Thank you for contributing to Boa! Please fill out the template below, and remove or add any information as you feel necessary. ---> Submitting this as a draft for feedback/second opinions. This draft contains some changes to the documentation. Quick Overview: - Potential `Boa` header for Boa's crates added to `boa_engine`. - Changes the wording to a lot of module headers (See `builtins` module and `object/builtins` module). - Updating built-in wrapper's code examples to use `?` operator. - Adds the doc logo URL to a few crates that didn't have it. The main idea of this draft is to move away from the "This module implements" wording as it feels a bit duplicative when listed under the Modules section (mainly focusing around changes in `boa_engine` to start). While working on this, I had a question about whether we should be using JavaScript or ECMAScript in the Boa's documentation. We do seem to currently use both, and this draft uses JavaScript heavily in the wording.
|
Pull request successfully merged into main. Build succeeded: |
bors
bot
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Submitting this as a draft for feedback/second opinions. This draft contains some changes to the documentation.
Quick Overview:
Boaheader for Boa's crates added toboa_engine.builtinsmodule andobject/builtinsmodule).?operator.The main idea of this draft is to move away from the "This module implements" wording as it feels a bit duplicative when listed under the Modules section (mainly focusing around changes in
boa_engineto start).While working on this, I had a question about whether we should be using JavaScript or ECMAScript in the Boa's documentation. We do seem to currently use both, and this draft uses JavaScript heavily in the wording.