Skip to content

Commit 91b05e6

Browse files
authored
Merge pull request #231 from arnog/patch-2
Fixed typo: @inheritdoc -> @inheritdoc
2 parents 0c84cb2 + ec89d9a commit 91b05e6

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ The TSDoc specification aims to meet these requirements:
5555
- **Common core**: Common tags such as `@param` and `@returns` will have consistent behavior across all tools.
5656
- **Extensible**: Each tool can supplement the core tags with custom tags for specialized scenarios.
5757
- **Interoperable**: The TSDoc standard guarantees that unsupported custom tags won't interfere with parsing of other content. TSDoc also eliminates Markdown ambiguities. (Are backticks allowed inside a `{@link}` tag? What happens if there is only one backtick? etc.)
58-
- **Multi-package support**: Many teams ship a collection of NPM packages that work together and are documented as a set. The cross-referencing syntax (e.g. `{@link}` or `{@inheritdoc}`) needs a portable way to reference API items imported from other packages. We also define *package.json* metadata that enables tooling to detect whether a dependency's *.d.ts doc comments should be parsed as TSDoc or not.
58+
- **Multi-package support**: Many teams ship a collection of NPM packages that work together and are documented as a set. The cross-referencing syntax (e.g. `{@link}` or `{@inheritDoc}`) needs a portable way to reference API items imported from other packages. We also define *package.json* metadata that enables tooling to detect whether a dependency's *.d.ts doc comments should be parsed as TSDoc or not.
5959
- **Open standard**: TSDoc is an open source, community-driven standard. You are encouraged to contribute your own ideas and pull requests.
6060

6161
The **@microsoft/tsdoc** library package brings in some additional goals:

0 commit comments

Comments
 (0)