[Bug 36477] New: We should use JSDoc
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=36477 Bug ID: 36477 Summary: We should use JSDoc Change sponsored?: --- Product: Koha Version: master Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: ERM Assignee: jonathan.druart@gmail.com Reporter: tomascohen@gmail.com CC: jonathan.druart@gmail.com, jonathan.field@ptfs-europe.com, martin.renvoize@ptfs-europe.com, matt.blenkinsop@ptfs-europe.com, pedro.amorim@ptfs-europe.com We need to add documentation to our JS codebase. We did some in some of our .js files, but the Vue classes should follow something like this: https://jsdoc.app/tags-param -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=36477 --- Comment #1 from Owen Leonard <oleonard@myacpl.org> --- +1 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=36477 --- Comment #2 from Pedro Amorim <pedro.amorim@ptfs-europe.com> --- Agreed. Adding tests for our JS functions would also be great (looking at you staff-global.js) -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=36477 Paul Derscheid <paul.derscheid@lmscloud.de> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |paul.derscheid@lmscloud.de -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=36477 --- Comment #3 from Martin Renvoize <martin.renvoize@ptfs-europe.com> --- I thought we already had a coding guideline for this but I'm not seeing it. I completely agree, we should require is and catch missing cases with the QA scripts if we can. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=36477 --- Comment #4 from Paul Derscheid <paul.derscheid@lmscloud.de> --- +1 to JSDoc and totally agree on qa-script integration. VSCod{e,ium} even generates the base for JSDoc automatically, so it's not really much additional work. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=36477 --- Comment #5 from Jonathan Druart <jonathan.druart@gmail.com> --- Who/Where/When? To add to the dev meeting agenda? -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=36477 --- Comment #6 from Paul Derscheid <paul.derscheid@lmscloud.de> --- Yes, let's add it. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=36477 Michaela Sieber <michaela.sieber@kit.edu> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |michaela.sieber@kit.edu --- Comment #7 from Michaela Sieber <michaela.sieber@kit.edu> --- Ping :-) -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=36477 --- Comment #8 from Owen Leonard <oleonard@myacpl.org> --- (In reply to Michaela Sieber from comment #7)
Ping :-)
This was discussed in a dev meeting: https://meetings.koha-community.org/2024/development_irc_meeting_17_april_20... Added to the wiki in May 2024: https://wiki.koha-community.org/wiki/Coding_Guidelines#JS15:_JSDoc As far as I can tell there hasn't been work done to add a check to the QA tool. -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org