CenterForDigitalHumanities / glossing-entries

Descriptions of new glosses and manuscripts, a data entry interface
1 stars 2 forks source link

Issue 209- Better Documentation for .js #210

Closed KamBustos closed 2 months ago

KamBustos commented 2 months ago

There are undocumented functions/code blocks that need documentation. Future teams can use this documentation to either help work on future issues, or better understand the codebase. When it comes to specific files that need this documentation, I would say the majority of them contain some form of functions/code blocks that can use new/extra details.

Files Currently Made Documentation to:

auth.js deer-config.js deer-record.js deer-render.js glossModal.js jwt.js layout.js mark.min.js ng.js plimit.js text-witness-line-selector.js tpen-line-selector.js witnessModal.js

Files that don't need documentation:

deer-utils.js deer.js gloss-transcription.js gloss-witness.js hello-world.js ( I don't even know what the purpose of this file serves) manageGlossModal.js openseadragon.js openseadragon.js.map openseadragon.min.js openseadragon.min.js.map worker.js (there is nothing in this file?) yocto.js