8000 chore(filesystem): improve docblock descriptions by jrmajor · Pull Request #345 · azjezz/psl · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

chore(filesystem): improve docblock descriptions #345

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
May 7, 2022
Merged

chore(filesystem): improve docblock descriptions #345

merged 3 commits into from
May 7, 2022

Conversation

jrmajor
Copy link
Contributor
@jrmajor jrmajor commented Apr 10, 2022 •
edited
Loading

Some of these changes are fixes of obvious mistakes, but the rest may be a bit opinionated. I'm open to discussing/reverting some of them :)

azjezz
azjezz reviewed Apr 11, 2022
View reviewed changes
Copy link
Owner
@azjezz azjezz left a comment

Choose a reason for hiding this comment

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

Thank you :)

one minor change.

@azjezz azjezz added Priority: Medium This issue may be useful, and needs some attention. Status: Revision Needed At least two people have seen issues in the PR that makes them uneasy. Type: Enhancement Most issues will probably ask for additions or changes. Type: Documentation Updating documentation labels Apr 11, 2022
@azjezz azjezz added this to the 2.0.0 milestone Apr 11, 2022
@jrmajor
Copy link
Contributor Author
jrmajor commented Apr 11, 2022

All @param annotations I checked are full sentences (begin with an uppercase letter and end with a period), but there are inconsistencies with @return. Do you have any preference on how they should be standardized?

@azjezz
Copy link
Owner
azjezz commented Apr 11, 2022

preference on how they should be standardized?

no, as long as things are consistent :)

@jrmajor
Copy link
Contributor Author
jrmajor commented Apr 11, 2022

Let's go with full sentences everywhere then :)

@coveralls
Copy link
coveralls commented Apr 11, 2022 •
edited
Loading

Pull Request Test Coverage Report for Build 2287127884

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 98.923%
Totals Coverage Status
Change from base Build 2287124210: 0.0%
Covered Lines: 3307
Relevant Lines: 3343
💛 - Coveralls

< 8000 div class="js-timeline-item js-timeline-progressive-focus-container" data-gid="C_kwDOGx01h9oAKDA1OWZiOTJhYmRlZDM1ZTQzNGE0MjIxMTRlZGI4ZGYzNmRlYjBmNDA">
@azjezz azjezz force-pushed the docs/filesystem branch from 0284bab to cc478ce Compare May 7, 2022 17:56
@azjezz azjezz merged commit e0d9140 into azjezz:2.0.x May 7, 2022
@jrmajor jrmajor deleted the docs/filesystem branch June 15, 2022 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@azjezz azjezz azjezz approved these changes

Assignees

@jrmajor jrmajor

Labels
Priority: Medium This issue may be useful, and needs some attention. Status: Revision Needed At least two people have seen issues in the PR that makes them uneasy. Type: Documentation Updating documentation Type: Enhancement Most issues will probably ask for additions or changes.
Projects
None yet
Milestone
2.0.0
Development

Successfully merging this pull request may close these issues.
3 participants
@jrmajor @azjezz @coveralls
0