Skip to content

test: validate @see contents #1231

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

Merged
merged 2 commits into from
Aug 5, 2022
Merged

test: validate @see contents #1231

merged 2 commits into from
Aug 5, 2022

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Aug 4, 2022

Checks that all @see faker method references to contain (...).

Invalid: @see faker.helpers.arrayElement
Valid: @see faker.helpers.arrayElement()

Note: I'm not sure whether empty () are the correct way to have. Especially, if the method requires parameters.

@ST-DDT ST-DDT requested a review from a team as a code owner August 4, 2022 18:34
@ST-DDT ST-DDT self-assigned this Aug 4, 2022
@ST-DDT ST-DDT requested a review from a team August 4, 2022 18:34
@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent c: test s: needs decision Needs team/maintainer decision c: infra Changes to our infrastructure or project setup labels Aug 4, 2022
@ST-DDT ST-DDT added this to the v7 - Current Major milestone Aug 4, 2022
@codecov
Copy link

codecov bot commented Aug 4, 2022

Codecov Report

Merging #1231 (c15767d) into main (9426e3a) will increase coverage by 0.00%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1231   +/-   ##
=======================================
  Coverage   99.62%   99.62%           
=======================================
  Files        2155     2155           
  Lines      236900   236900           
  Branches      990      991    +1     
=======================================
+ Hits       236012   236015    +3     
+ Misses        867      864    -3     
  Partials       21       21           
Impacted Files Coverage Δ
src/modules/internet/user-agent.ts 82.53% <0.00%> (+0.79%) ⬆️

Copy link
Member

@Shinigami92 Shinigami92 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the start I think this is good enough, but it might be that we want to enhance the check in the future if we encounter some weird tag content ^^

Like @see faker is (a really cool) tool

@ST-DDT ST-DDT requested review from a team August 4, 2022 22:28
@ST-DDT ST-DDT enabled auto-merge (squash) August 5, 2022 06:29
@ST-DDT ST-DDT merged commit 23d86aa into main Aug 5, 2022
@ST-DDT ST-DDT deleted the consistent-jsdoc-see branch August 5, 2022 06:38
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 c: infra Changes to our infrastructure or project setup c: test p: 1-normal Nothing urgent s: needs decision Needs team/maintainer decision
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants