-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
lib/node.d.ts - Improved documentation #1846
Conversation
Improved documentation in lib/node.d.ts module.
Removed extra whitespace.
lib/node.d.ts
Outdated
* The file source of the node. | ||
* The source file from where a node has originated. | ||
* | ||
* @type {Input} |
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.
We do not need @type
since it is already .d.ts
file and types and written above: input: Input
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.
understood
lib/node.d.ts
Outdated
* | ||
* ```js | ||
* root.nodes[0].parent === root | ||
* console.log(root.nodes[0].parent === root); //=> true |
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.
Could you remove ;
? Just to keep consistancy across docs.
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.
I was thinking to add semi-colon throughout the project...
lib/node.d.ts
Outdated
* const prefixed = postcss.decl({ | ||
* prop: '-moz-' + decl.prop, | ||
* value: decl.value | ||
* }) | ||
* value: decl.value, |
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.
And leading ,
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.
I think we should keep leading, it looks nice :Dz
I will make it consistent throughout the project.
Looks good! Congrats with the first PR! Just a few code style changes and we are ready to merge. |
Co-authored-by: Andrey Sitnik <andrey@sitnik.ru>
Still learning stuff, sorry for mistakes :) |
It is not a mistake, just my own code style preferences. Fix the |
understood, fixed all, please review :) |
Congrats! |
Hello, this is my first pull request!
Please review and accept if you like the documentation changes.
If this pull request gets accepted, I will improve documentation for the
whole Post CSS project.
I want to learn Post CSS better, so I have started by writing the documentation
for whole project.