ICJIA / arrest_explorer

Distribution of, and interface to, aggregated Illinois arrest data.
https://icjia.illinois.gov/arrestexplorer
1 stars 0 forks source link

Comments in source code #21

Open cschweda opened 3 years ago

cschweda commented 3 years ago

Is your feature request related to a specific use case? Please describe. In the words of Steve Ballmer, "Developers, developers, developers."

Describe the solution you'd like Would it possible to provide (a few more) comments in the source code?

Especially:

Additional context Nothing detailed -- just a few general guidelines at what's happening at various points. Especially the parser.

How would this help? This would assist with ad hoc debugging -- as well as future developers (in addition to folks who might fork the repo).

Thank you! :)

miserman commented 3 years ago

This will definitely be part of the plan for this month, along with more implementation details in the readme and/or on the documentation site.

kgruschow commented 3 years ago

this is at medium priority, where for clarification priority is essentially: high priority > documentation > other accessibility and major UI issues > other issues