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

Unify @see jsdoc tags #2057

Closed
Shinigami92 opened this issue Apr 16, 2023 · 1 comment · Fixed by #2473
Closed

Unify @see jsdoc tags #2057

Shinigami92 opened this issue Apr 16, 2023 · 1 comment · Fixed by #2473
Assignees
Labels
c: docs Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Milestone

Comments

@Shinigami92
Copy link
Member

While working on some @see tags, because @ST-DDT and @xDivisionByZerox pointed that to me, I found that your current code base is very unstructurized in terms of the @see tag.

Sometimes sentences are starting with an upper case, sometimes with a lower case.
Sometimes they end or end not with a period (.).
Sometimes they have no description at all.

@Shinigami92 Shinigami92 added the c: docs Improvements or additions to documentation label Apr 16, 2023
@Shinigami92 Shinigami92 moved this to In Progress in Faker Roadmap Apr 16, 2023
@Shinigami92 Shinigami92 moved this from In Progress to Todo in Faker Roadmap Apr 16, 2023
@xDivisionByZerox
Copy link
Member

If additional context after the @see tag should be a grammatically correct sentence. This means they should all that's with an uppercase letter and end with a period.

@xDivisionByZerox xDivisionByZerox added good first issue Good for newcomers help wanted Extra attention is needed labels Jul 14, 2023
@ST-DDT ST-DDT self-assigned this Oct 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
No open projects
Status: Todo
Development

Successfully merging a pull request may close this issue.

3 participants