Comments (8)
I am not against JSDoc, i personally prefer it. But I dont know the opinion of the other maintainers.
from nock.
I'm not sure this is the best option for documentation, but I see your point.
p.s: I'm using JSDoc as well for types.
from nock.
Yes, the idea is not to replace the current documentation, but add some in JSDoc to improve developer experience
from nock.
@QuentinLemCode how can we make sure the jsdoc and readme are updated and one of them not left behind?
from nock.
@QuentinLemCode how can we make sure the jsdoc and readme are updated and one of them not left behind?
@mikicho The most obvious would be to add the rule to the contributing guideline and PR template.
If you think we need to enforce it with a CI test for example, maybe we can rework the Readme to have a structure we can reuse to generate JSDoc or inversely.
Do you have suggestions?
from nock.
I haven't used jsdoc for documentation previously, so any solution that establishes a single source of truth is acceptable to me.
from nock.
@mikicho
Sure, I propose to make JSDoc the single source of truth in that case. Because JSDoc is structured, it's easier to generate markdown from JSDoc than the inverse.
This project can help us achieve that : https://github.com/jsdoc2md/jsdoc-to-markdown
Another thing to take in mind is the typescript type definition file. We can use the typescript compiler to generate the type definition from JSDoc : https://www.typescriptlang.org/docs/handbook/declaration-files/dts-from-js.html
A CI build step can be added for that.
Is that all right with you?
from nock.
A solution I looked for in the past is to have sections in the README wrapped HTML comment tags (e.g. somethin like <!-- jsdoc path/to/file.js#method --> ... <!-- /jsdoc -->
) which could then include API specs that are defined in JS Doc. That way we would keep a high level documentation of our README, but could also include docs that live in the code, avoiding duplication. But I was not successful in the past. Maybe you know a solution that could provide that?
But even if that's not possible, I wouldn't mind adding descriptions via JSDocs, I'd just keep them short, and add a link to the README for more)
from nock.
Related Issues (20)
- enableNetConnect does not work w nock.recorder.rec() HOT 1
- [Node 18.12] Class extends value undefined is not a constructor or null HOT 2
- incompatible behaviour introduced with v13.3.2 HOT 17
- Interceptors not being removed in 13.3.2 HOT 2
- Replace npm debug with require('node:util').debuglog HOT 2
- Remove lodash HOT 1
- Application to become a nock maintainer. HOT 5
- Expand function fails on weird GET query params HOT 4
- reqheaders does not work when using an undefined requestBody HOT 3
- Add interceptor at the beginning of list
- Return 500 instead of 404 HOT 4
- Bun support for nock.disableNetConnect() HOT 1
- DNS resolve errors and not mocking a lot of requests HOT 7
- POST request with ReadStream request body does not return a response HOT 10
- Disabled discussions HOT 6
- Improve debug logging HOT 2
- Support Abort Signals HOT 1
- Using nock inside a stream pipeline with got causes it to hang forever since Node 20.10.0 HOT 2
- Debug logging broken in beta (14.0.0-beta.5)
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 nock.