Unify Documentation for Assertions #157
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In #130 (comment), it's pointed out that the descriptions of each assertion is different between the readme and the
assert.ts
file. For example,expectDeprecated()
is defined as:https://github.com/SamVerschueren/tsd/blob/14f28125e74ca533645d264209e7f9fd0e778568/source/lib/assertions/assert.ts#L55-L63
Whereas the readme says:
This PR changes each assertion description to consistently use
expression
and to say:In addition, the documentation comment of each assertion handler follows the same form: