Skip to content

Commit

Permalink
chore: Update docs for converter2
Browse files Browse the repository at this point in the history
  • Loading branch information
Gerrit0 committed Mar 29, 2021
1 parent a11a929 commit 315bd25
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion .github/CONTRIBUTING.md
Expand Up @@ -103,7 +103,10 @@ To compile the TypeDoc source, run `npm run build`. This will start the TypeScri

TypeDoc includes an extensive set of tests that describe its output. To validate any changes you have made, build the project and then run `npm test`. Alternatively, to rebuild with your changes and then immediately test, run `npm run build_and_test`.

If you have changed the TypeDoc output, it will cause tests to fail. Once you have validated that the introduced changes were intended, run `node scripts/rebuild_specs` to update the spec files for the new output.
If you have changed the TypeDoc output, it will cause tests to fail. Once you have validated that the introduced changes were intended, run `npm run rebuild_specs` to update the spec files for the new output.

Additional tests are contained within the `converter2` directory that look for specific issues with previous
builds and may be more appropriate for adding a test for a bugfix.

## Pull Requests

Expand Down

0 comments on commit 315bd25

Please sign in to comment.