Skip to content

docs: fix @param guidance in style guide #2969

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.

Sign up for GitHub

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
thisisjofrank merged 3 commits into from
Mar 12, 2026
Merged

docs: fix @param guidance in style guide #2969

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eeead03
docs: fix @param guidance in style guide
tomas-zijdemans Mar 12, 2026
64ba484
Merge branch 'main' into styleguide-param
tomas-zijdemans Mar 12, 2026
823256f
Merge branch 'main' into styleguide-param
thisisjofrank Mar 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions runtime/contributing/style_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,15 +257,15 @@ For example:
/** Import something from the `deno` module. */
```

Do not document function arguments unless they are non-obvious of their intent
(though if they are non-obvious intent, the API should be considered anyways).
Therefore `@param` should generally not be used. If `@param` is used, it should
not include the `type` as TypeScript is already strongly-typed.
Every exported function should have a `@param` tag for each parameter with a
description. The `@param` tag should not include the `type` as TypeScript is
already strongly-typed.

```ts
/**
* Function with non-obvious param.
* @param foo Description of non-obvious parameter.
* Resolves a path to a file.
* @param path The path to resolve.
* @param base The base directory to resolve from.
*/
```

Expand Down
Loading