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 broken link in contributing doc. #1018

Merged
merged 1 commit into from May 29, 2020
Merged

Fix broken link in contributing doc. #1018

merged 1 commit into from May 29, 2020

Conversation

Awjin
Copy link
Contributor

@Awjin Awjin commented May 29, 2020

Fixes #1017

@Awjin Awjin requested a review from jathak May 29, 2020 16:42
@@ -166,7 +166,7 @@ JS and loading that JS using JS interop to best simulate the conditions under
which it will be used in the real world.

[npm]: https://www.npmjs.com/package/sass
[JS interop]: https://pub.dartlang.org/packages/js
[JS interop package]: https://pub.dartlang.org/packages/js

Choose a reason for hiding this comment

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

In my opinion, this correction is incorrect it will give:

 It's defined using Dart's [JS interop package][],

the correction should be a few lines up, giving the entire, corrected paragraph:

### Changing the Node API

Most of Dart Sass's code is shared between Dart and Node.js, but the API that's
exported by the [`sass`][npm] npm package is Node-specific. It's defined using
Dart's [JS interop package][JS], and it's tested by compiling the Dart package to
JS and loading that JS using JS interop to best simulate the conditions under
which it will be used in the real world.

[npm]: https://www.npmjs.com/package/sass
[JS]: https://pub.dartlang.org/packages/js

so the corrected lines are:

Dart's [JS interop package][JS], and it's tested by compiling the Dart package to

and

[JS]: https://pub.dartlang.org/packages/js

Copy link
Member

Choose a reason for hiding this comment

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

Reference links with no label in the second set of brackets are implicitly labeled with the text being linked, so JS interop package correctly refers to that link. See https://daringfireball.net/projects/markdown/syntax#link

Choose a reason for hiding this comment

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

One is never to old to learn... , though I would prefer the explicit version (but that is my personal opinion)..

@Awjin Awjin merged commit 69627fb into master May 29, 2020
@Awjin Awjin deleted the update-contributing branch May 29, 2020 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Incorrect / no reference in CONTRIBUTING.md
3 participants