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

Fix unresolved links in documentation #960

Merged
merged 5 commits into from
Dec 11, 2020
Merged

Fix unresolved links in documentation #960

merged 5 commits into from
Dec 11, 2020

Conversation

tofpie
Copy link
Contributor

@tofpie tofpie commented Dec 11, 2020

This Pull Request fixes #957.

It changes the following:

  • Unresolved or misinterpreted links in the documentation

@codecov
Copy link

codecov bot commented Dec 11, 2020

Codecov Report

Merging #960 (beb2c45) into master (98e11d7) will increase coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #960      +/-   ##
==========================================
+ Coverage   59.29%   59.32%   +0.02%     
==========================================
  Files         166      166              
  Lines       10689    10687       -2     
==========================================
+ Hits         6338     6340       +2     
+ Misses       4351     4347       -4     
Impacted Files Coverage Δ
boa/src/builtins/boolean/mod.rs 30.00% <ø> (ø)
boa/src/builtins/function/mod.rs 73.73% <ø> (ø)
boa/src/builtins/map/map_iterator.rs 71.92% <ø> (ø)
boa/src/builtins/number/conversions.rs 68.42% <ø> (ø)
boa/src/builtins/number/mod.rs 60.56% <ø> (ø)
boa/src/builtins/object/mod.rs 64.93% <ø> (ø)
boa/src/context.rs 61.26% <ø> (ø)
boa/src/environment/function_environment_record.rs 35.10% <ø> (ø)
boa/src/object/gcobject.rs 64.20% <ø> (ø)
boa/src/object/internal_methods.rs 57.14% <ø> (ø)
... and 9 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 98e11d7...31a1623. Read the comment docs.

Copy link
Member

@Razican Razican left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution! This cleans up a lot of stuff in the docs :)

I only noticed two minor things that could be improved.

Comment on lines 680 to 684
/// - [ECMAScript reference](
/// - [MDN documentation][mdn]
///
/// [spec]: https://tc39.es/ecma262/#prod-LogicalORExpression)
/// [mdn]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Logical_Operators#Logical_OR
/// [spec]: <https://tc39.es/ecma262/#prod-LogicalORExpression)>
/// [mdn]: <https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Logical_Operators#Logical_OR>
Copy link
Member

Choose a reason for hiding this comment

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

I believe this is not correct, right? It should show [spec] next to [ECMAScript reference], and then, the links should not have <...>. Also, the spec link should not have a closing )

boa/src/value/mod.rs Outdated Show resolved Hide resolved
@Razican Razican added this to the v0.11.0 milestone Dec 11, 2020
@Razican Razican added bug Something isn't working documentation update documentation labels Dec 11, 2020
tofpie and others added 2 commits December 11, 2020 17:23
Co-authored-by: Iban Eguia <razican@protonmail.ch>
Copy link
Member

@Razican Razican left a comment

Choose a reason for hiding this comment

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

Thanks! This looks good to me :)

@RageKnify RageKnify merged commit 0c068cb into boa-dev:master Dec 11, 2020
@tofpie tofpie deleted the fix-957 branch December 25, 2020 18:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation update documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unresolved links in documentation
3 participants