Skip to content
This repository has been archived by the owner on Jan 27, 2023. It is now read-only.

Adds jsdoc rule #11

Closed
wants to merge 1 commit into from
Closed

Adds jsdoc rule #11

wants to merge 1 commit into from

Conversation

brianjhanson
Copy link
Contributor

Forces documentation of your functions.

https://eslint.org/docs/rules/valid-jsdoc

@mkornatz
Copy link
Contributor

I suggest:

"valid-jsdoc": ["error", { "requireReturnDescription": false, "requireParamDescription": false }]

because params are often self-explanatory as are return types and names

@MikeMcChillin
Copy link
Contributor

This one's too far for me. I have a feeling it would be super annoying.

@cmalven
Copy link

cmalven commented Nov 16, 2017

This one's been open for 3 months. Are we ready to give up on it?

@brianjhanson
Copy link
Contributor Author

Yep, didn't seem terribly popular.

@cmalven
Copy link

cmalven commented Nov 16, 2017

FWIW, I like the idea of it even if it would be incredibly annoying.

@brianjhanson
Copy link
Contributor Author

Yeah, me too, although admittedly the project I'm working on has the rule enforced and I've turned it off all over because most of the functions I'm writing are self-explanatory (and react-y)

@cmalven
Copy link

cmalven commented Nov 16, 2017

Yep, that's what I figure would happen with me, too. I really want to get better about documenting my JS I just haven't found a way to force myself to do it yet.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants