On 24/10/2022 15:07, Mike Conley wrote:
That having been said, along with getting us into a consistent state,
is part of this project also to beef up the amount of automatically
JSDoc-generated documentation that gets put up on Firefox Source Docs?
The list of things that actually do that is quite small:
https://searchfox.org/mozilla-central/rev/88f285c5163f73abd209d4f73cfa476660351982/docs/conf.py#52-67
- so is the plan to enable this consistent styling and then to add to
this Python list, or is that more of a separate task that we leave up
to the relevant owners / peers of the code?
There's not been any discussion between the two areas.
On the ESLint side this is something we've wanted to do for a while -
the old rules are still supported, but they are legacy so they could get
dropped at some stage.
However, having docs that are more spec compliant will likely help the
automatic jsdoc generation, so it might be a good idea to link enabling
these together in some way.
Additionally, those existing jsdoc generated areas might be a good
starting point to roll the configurations out to more places - that way
developers can have local checks run before they push patches to automation.
Mark
--
You received this message because you are subscribed to the Google Groups
"[email protected]" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/a/mozilla.org/d/msgid/dev-platform/70e01b11-068e-6dee-c877-60ece80048ac%40mozilla.com.
