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

lib/node.d.ts - Improved documentation #1846

Merged
merged 6 commits into from Jun 29, 2023
Merged

lib/node.d.ts - Improved documentation #1846

merged 6 commits into from Jun 29, 2023

Conversation

ghost
Copy link

@ghost ghost commented Jun 28, 2023

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.

vikaskaliramna07 added 2 commits June 28, 2023 12:23
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}
Copy link
Member

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

Copy link
Author

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
Copy link
Member

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.

Copy link
Author

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,
Copy link
Member

Choose a reason for hiding this comment

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

And leading ,

Copy link
Author

@ghost ghost Jun 28, 2023

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.

lib/node.d.ts Outdated Show resolved Hide resolved
@ai
Copy link
Member

ai commented Jun 28, 2023

Looks good! Congrats with the first PR!

Just a few code style changes and we are ready to merge.

vikaskaliramna07 and others added 2 commits June 28, 2023 19:57
Co-authored-by: Andrey Sitnik <andrey@sitnik.ru>
@ghost
Copy link
Author

ghost commented Jun 28, 2023

Still learning stuff, sorry for mistakes :)

@ai
Copy link
Member

ai commented Jun 28, 2023

Still learning stuff, sorry for mistakes :)

It is not a mistake, just my own code style preferences.

Fix the ; and leading , in examples and we are ready to merge.

@ghost
Copy link
Author

ghost commented Jun 29, 2023

understood, fixed all, please review :)

@ai ai merged commit 857a732 into postcss:main Jun 29, 2023
@ai
Copy link
Member

ai commented Jun 29, 2023

Congrats!

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.

None yet

1 participant