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

Format code snippets in docs #3317

Merged
merged 1 commit into from
Sep 27, 2023
Merged

Format code snippets in docs #3317

merged 1 commit into from
Sep 27, 2023

Conversation

jedel1043
Copy link
Member

Uses cargo +nightly fmt -- --config=format_code_in_doc_comments=true --config=doc_comment_code_block_width=80 to format all docs with code blocks.

@jedel1043 jedel1043 added the documentation update documentation label Sep 27, 2023
@jedel1043 jedel1043 added this to the v0.18.0 milestone Sep 27, 2023
@jedel1043 jedel1043 requested a review from a team September 27, 2023 18:01
@github-actions
Copy link

Test262 conformance changes

Test result main count PR count difference
Total 95,574 95,574 0
Passed 75,181 75,181 0
Ignored 19,494 19,494 0
Failed 899 899 0
Panics 0 0 0
Conformance 78.66% 78.66% 0.00%

@codecov
Copy link

codecov bot commented Sep 27, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (a23335b) 49.69% compared to head (f6d1da7) 49.69%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3317   +/-   ##
=======================================
  Coverage   49.69%   49.69%           
=======================================
  Files         443      443           
  Lines       43141    43141           
=======================================
  Hits        21439    21439           
  Misses      21702    21702           
Files Coverage Δ
boa_ast/src/statement/switch.rs 100.00% <ø> (ø)
boa_cli/src/main.rs 0.61% <ø> (ø)
boa_engine/src/context/hooks.rs 58.06% <ø> (ø)
boa_engine/src/context/mod.rs 55.55% <ø> (ø)
boa_engine/src/error.rs 32.55% <ø> (ø)
boa_engine/src/job.rs 43.75% <ø> (ø)
boa_engine/src/lib.rs 73.33% <ø> (ø)
boa_engine/src/module/mod.rs 3.20% <ø> (ø)
boa_engine/src/object/builtins/jsdataview.rs 0.00% <ø> (ø)
boa_engine/src/object/builtins/jsdate.rs 0.00% <ø> (ø)
... and 12 more

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nekevss nekevss added this pull request to the merge queue Sep 27, 2023
Merged via the queue into main with commit ae41479 Sep 27, 2023
@raskad raskad deleted the fmt-code-in-doc branch September 30, 2023 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation update documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants