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

Validates documentation on push #546

Closed
wants to merge 6 commits into from
Closed

Conversation

Falci
Copy link
Member

@Falci Falci commented Jan 28, 2021

This will trigger the jsdoc after each push/merge to master.
The documentation will be generated and discarded, but this guarantees the docs are valid.

package.json Outdated Show resolved Hide resolved
@Falci
Copy link
Member Author

Falci commented Feb 4, 2021

IMO, the project should include it since it's literally a "devDependency".
Since the project already miss the other dependencies (lint and coverage) I'm removing jsdoc to keep it consistent.

@coveralls
Copy link

coveralls commented Feb 4, 2021

Pull Request Test Coverage Report for Build 538263067

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.005%) to 59.722%

Totals Coverage Status
Change from base Build 537972804: 0.005%
Covered Lines: 19594
Relevant Lines: 30581

💛 - Coveralls

@pinheadmz
Copy link
Member

Looks good, checked a bad-docs PR against my own master branch: pinheadmz#6

We can merge, but @Falci can you clean up the commits if possible? Even just squash to one commit would work.

pinheadmz added a commit to pinheadmz/hsd that referenced this pull request Mar 10, 2021
@pinheadmz
Copy link
Member

merged in 9c7bc0a

@pinheadmz pinheadmz closed this Mar 10, 2021
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

4 participants