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

Add basic documentation #42

Closed
tpodolak opened this issue Oct 21, 2018 · 1 comment
Closed

Add basic documentation #42

tpodolak opened this issue Oct 21, 2018 · 1 comment
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@tpodolak
Copy link
Member

Add documentation for every diagnostic rule, with a simple explanation of why it is reported and how to fix it

@tpodolak tpodolak added the enhancement New feature or request label Oct 21, 2018
@tpodolak tpodolak self-assigned this Oct 21, 2018
tpodolak added a commit that referenced this issue Oct 21, 2018
tpodolak added a commit that referenced this issue Oct 22, 2018
dtchepak added a commit that referenced this issue Oct 22, 2018
* [GH-42] - First draft od diagnostic documentation

* [GH-42] - First attempts to validate documentation layout

* [GH-42] - Tests for validating diagnostic identifier documentations

* [GH-42] - Adding nsubstitute.schema.json and additional documentation

* [GH-42] - Supression examples added

* [GH-42] - General documentation file added

* Documentation review

* [GH-42] - Updating documentation and tests after code review changes

* [GH-42] - proper urls for documentation
@dtchepak
Copy link
Member

Closed by #43

@tpodolak tpodolak added this to the 1.0.0 milestone Apr 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants