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

Class naming inconsistencies: singular vs plural #1176

Closed
angristan opened this issue Apr 19, 2020 · 2 comments · Fixed by #1179
Closed

Class naming inconsistencies: singular vs plural #1176

angristan opened this issue Apr 19, 2020 · 2 comments · Fixed by #1179

Comments

@angristan
Copy link
Contributor

angristan commented Apr 19, 2020

I'm submitting a...


[ ] Regression 
[ ] Bug report
[ ] Feature request
[x] Documentation issue or request (new chapter/page)
[ ] Support request => Please do not submit support request here, instead post your question on Stack Overflow.

Current behavior

Some classes are named inconsistently across and sometimes even within examples. For example, classes related to the User entity:

+ grep -ri UsersController content/
+ wc -l
       6
+ grep -ri UserController content/
+ wc -l
       4
+ grep -ri UsersService content/
+ wc -l
      59
+ grep -ri UserService content/
+ wc -l
      10
+ grep -ri UsersRepository content/
+ wc -l
      12
+ grep -ri UserRepository content/
+ wc -l
       1

Expected behavior

As a newcomer, I have a hard time figuring what my classes should be named like. Is there any convention? It is quite confusing. 😅

@kamilmysliwiec
Copy link
Member

Plural form is recommended :) Would you like to create a PR for this issue?

@angristan
Copy link
Contributor Author

Ok thanks, I'll make a PR!

angristan added a commit to angristan/docs.nestjs.com that referenced this issue Apr 20, 2020
Fix nestjs#1176

According to @kamilmysliwiec, "plural form is recommended".

I updated some of the singularly named classes and updated them, along
with file names.

Signed-off-by: Stanislas Lange <[email protected]>
angristan added a commit to angristan/docs.nestjs.com that referenced this issue Apr 20, 2020
Fix nestjs#1176

According to @kamilmysliwiec, "plural form is recommended".

I updated some of the singularly named classes and updated them, along
with file names.

Signed-off-by: Stanislas Lange <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants