Comments (3)
@pgonzal Sure. My gut reaction is that if you frequently need to suppress parts of tsdoc, you are getting more into a docs linter. While that may be helpful when generating documentation, I don't know that it should be part of tsdoc core, especially early on. My impression is that linter rules change frequently and maintaining them in the core library could complicate things.
Coming from typedoc's loose parsing of doc comments, I don't see myself looking for this feature to be included.
from tsdoc.
@aciccarello could you provide a little more detail? :-P Does the design seem misguided? Or are you just saying that you wouldn't personally need this feature?
Is your concern mainly with the @suppress
tag, or do you also dislike the idea of labeling each error with a name such as ae-undocumented-link-target
? I also considered the TypeScript compiler's approach, where diagnostics have numbers (e.g. TS1003
). However that seemed less readable.
from tsdoc.
@aciccarello I've come around to the same viewpoint. The most common use case for suppressions is to bulk-ignore all legacy violations, so that we can start applying the stricter rules for new changes going forward. In this situation, tracking suppressions in source code comments is clumsy and clutters the code. Such suppressions really need to go in a file (e.g. suppressions.json) that can be easily generated by a tool.
I'm going to close this RFC.
from tsdoc.
Related Issues (20)
- Validate invalid params through tsdoc eslint plugin HOT 1
- This repo is missing important files
- Documentation coverage? HOT 1
- JSDoc/TSDoc `@inherit[dD]oc` mismatch HOT 1
- Is it dead? HOT 4
- VS Code unable to load Schema
- tsdoc-unnecessary-backslash false positive
- Weird warnings about multiple declarations HOT 1
- Grouping classes under the same index name
- Support for defining custom tag syntax HOT 1
- tsdoc-html-tag-missing-equals erroneously flagging boolean attributes
- tsdoc-malformed-html-name erroneously flagging use of less than symbol HOT 1
- Unable to load schema from 'https://json.schemastore.org/tsconfig HOT 1
- `tsdoc-reference-unquoted-identifier` is incorrectly reported for certain identifiers
- [ Question ][ Playground ] Intended Behaviour? HOT 2
- eslint-plugin-tsdoc: Missing rule to check for absence of a TSDoc comment HOT 1
- ESLint flat configurations? HOT 1
- "extends": "@rushstack/heft-node-rig/profiles/default/config/jest.config.json"
- Can inherit doc also copy the TSDoc when I hover?
- Support tables in TSDoc comments HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from tsdoc.