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.

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

Improve docs #17

Open
4 of 5 tasks
ajafff opened this issue Jun 6, 2017 · 1 comment
Open
4 of 5 tasks

Improve docs #17

ajafff opened this issue Jun 6, 2017 · 1 comment
Assignees
@ajafff

Comments

@ajafff
Copy link
Owner

ajafff commented Jun 6, 2017 •
edited

The docs could really use some love.

  • rephrase stuff
  • add code samples
  • add config examples
  • create a documentation page for each rule (instead of dumping everything in README)
  • rewrite naming-convention docs
@ajafff ajafff self-assigned this Jun 6, 2017
ajafff added a commit that referenced this issue Jun 30, 2017
@ajafff
Move and improve docs
3de70e9 
Refs: #17
@ajafff ajafff mentioned this issue Jun 30, 2017
Merged
ajafff added a commit that referenced this issue Jun 30, 2017
@ajafff
Move and improve docs
d1893dc 
Refs: #17
@DerZyklop
Copy link

Esamples of naming-convention is missing at least typeAlias, parameterProperty, enum and the new accessor.

https://github.com/ajafff/tslint-consistent-codestyle/blob/master/docs/naming-convention.md#examples

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ajafff ajafff

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@DerZyklop @ajafff