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

doc(node): Fix jsdoc for HRTime, modify test #71370

Merged

Conversation

hkleungai
Copy link
Contributor

Resolves #69870.
Also see https://nodejs.org/api/process.html#processhrtimetime.


Please fill in this template.

Select one of these and delete the others:

If changing an existing definition:

  • Provide a URL to documentation or source code which provides context for the suggested changes: <>

@typescript-bot
Copy link
Contributor

typescript-bot commented Dec 8, 2024

@hkleungai Thank you for submitting this PR!

This is a live comment that I will keep updated.

1 package in this PR

Code Reviews

Because this is a widely-used package, a DT maintainer will need to review it before it can be merged.

You can test the changes of this PR in the Playground.

Status

  • ✅ No merge conflicts
  • ✅ Continuous integration tests have passed
  • ✅ Most recent commit is approved by a DT maintainer

All of the items on the list are green. To merge, you need to post a comment including the string "Ready to merge" to bring in your changes.


Diagnostic Information: What the bot saw about this PR
{
  "type": "info",
  "now": "-",
  "pr_number": 71370,
  "author": "hkleungai",
  "headCommitOid": "37fdb8680ff81d8cbb790e07f4368f59c6fb7889",
  "mergeBaseOid": "61576c3c5bcb6518f86224fcb0a2314ac68e4ebb",
  "lastPushDate": "2024-12-08T04:56:54.000Z",
  "lastActivityDate": "2025-01-16T00:20:00.000Z",
  "mergeOfferDate": "2025-01-15T22:52:10.000Z",
  "mergeRequestDate": "2025-01-16T00:20:00.000Z",
  "mergeRequestUser": "hkleungai",
  "hasMergeConflict": false,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Critical",
  "pkgInfo": [
    {
      "name": "node",
      "kind": "edit",
      "files": [
        {
          "path": "types/node/process.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/node/test/process.ts",
          "kind": "test"
        },
        {
          "path": "types/node/v16/process.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/node/v16/test/process.ts",
          "kind": "test"
        },
        {
          "path": "types/node/v18/process.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/node/v18/test/process.ts",
          "kind": "test"
        },
        {
          "path": "types/node/v20/process.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/node/v20/test/process.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "Microsoft",
        "jkomyno",
        "alvis",
        "r3nya",
        "btoueg",
        "smac89",
        "touffy",
        "DeividasBakanas",
        "eyqs",
        "Hannes-Magnusson-CK",
        "hoo29",
        "kjin",
        "ajafff",
        "islishude",
        "mwiktorczyk",
        "mohsen1",
        "galkin",
        "parambirs",
        "eps1lon",
        "ThomasdenH",
        "WilcoBakker",
        "wwwy3y3",
        "samuela",
        "kuehlein",
        "bhongy",
        "chyzwar",
        "trivikr",
        "yoursunny",
        "qwelias",
        "ExE-Boss",
        "peterblazejewicz",
        "addaleax",
        "victorperin",
        "ZYSzys",
        "NodeJS",
        "LinusU",
        "wafuwafu13",
        "mcollina",
        "Semigradsky"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Critical"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "RyanCavanaugh",
      "date": "2025-01-15T22:51:29.000Z",
      "isMaintainer": true
    },
    {
      "type": "stale",
      "reviewer": "Renegade334",
      "date": "2024-12-09T17:39:05.000Z",
      "abbrOid": "f351cf5"
    }
  ],
  "mainBotCommentID": 2525418819,
  "ciResult": "pass"
}

@hkleungai hkleungai force-pushed the node-process-hrtime-jsdoc-fix branch from f351cf5 to 37fdb86 Compare December 9, 2024 17:59
@typescript-bot
Copy link
Contributor

@Renegade334 Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

@typescript-bot typescript-bot added the Unreviewed No one showed up to review this PR, so it'll be reviewed by a DT maintainer. label Dec 19, 2024
@typescript-bot
Copy link
Contributor

@typescript-bot
Copy link
Contributor

* }, 1000);
* ```
* @since 0.7.6
* @legacy Use {@link process.hrtime.bigint()} instead.
Copy link
Contributor

Choose a reason for hiding this comment

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

@legacy is not a known jsdoc tag. It should be written as @deprecated.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry for the late response. @legacy is used due to @Renegade334's suggestion on previous review comment. I think I am not gonna change it.

@typescript-bot typescript-bot added Maintainer Approved Self Merge This PR can now be self-merged by the PR author or an owner and removed Unreviewed No one showed up to review this PR, so it'll be reviewed by a DT maintainer. labels Jan 15, 2025
@typescript-bot
Copy link
Contributor

@hkleungai: Everything looks good here. I am ready to merge this PR (at 37fdb86) on your behalf whenever you think it's ready.

If you'd like that to happen, please post a comment saying:

Ready to merge

and I'll merge this PR almost instantly. Thanks for helping out! ❤️

(@microsoft, @jkomyno, @alvis, @r3nya, @btoueg, @smac89, @Touffy, @DeividasBakanas, @eyqs, @Hannes-Magnusson-CK, @hoo29, @kjin, @ajafff, @islishude, @mwiktorczyk, @mohsen1, @galkin, @parambirs, @eps1lon, @ThomasdenH, @WilcoBakker, @wwwy3y3, @samuela, @kuehlein, @bhongy, @chyzwar, @trivikr, @yoursunny, @qwelias, @ExE-Boss, @peterblazejewicz, @addaleax, @victorperin, @ZYSzys, @nodejs, @LinusU, @wafuwafu13, @mcollina, @Semigradsky: you can do this too.)

@hkleungai
Copy link
Contributor Author

Ready to merge

@typescript-bot typescript-bot merged commit e61ef76 into DefinitelyTyped:master Jan 16, 2025
15 checks passed
@hkleungai hkleungai deleted the node-process-hrtime-jsdoc-fix branch January 16, 2025 00:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Critical package Maintainer Approved Self Merge This PR can now be self-merged by the PR author or an owner
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants