Not planned
Description
Some documented methods have the C++ definition before the description:
Lines 87 to 104 in b8525e2
... while others have the description before the C++ definition:
Lines 144 to 161 in b8525e2
For some rough stats, it seems to be split almost evenly... Searching for ### .+\n+```
(ie. definition first) gives 208 results, while ### .+\n+\w
(ie. description first) gives 219 results.
Do we have a preference? Does it matter?
Metadata
Assignees
Type
Projects
Status
Done
Milestone
Relationships
Development
No branches or pull requests
Activity
mhdawson commentedon Jul 5, 2024
We should check the Node.js api docs in nodejs/node/doc/api to see which it does and likely follow that.
github-actions commentedon Oct 4, 2024
This issue is stale because it has been open many days with no activity. It will be closed soon unless the stale label is removed or a comment is made.
Furqan-Nadir commentedon Oct 25, 2024
Personally, I would prefer having documentation above the definition specifically because having a context on what you are reading makes it easier to understand and analyze.
github-actions commentedon Jan 24, 2025
This issue is stale because it has been open many days with no activity. It will be closed soon unless the stale label is removed or a comment is made.