HydrologicEngineeringCenter / HydrologicEngineeringCenter/Vortex
Jython docs for all tools (timeshifter, transposer, etc)
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 37
- Forks
- 7
- PR merge metrics
- No merged PRs in 30d
Description
Good afternoon,
There is complete documentation on the Jython API for the Importer tool, and it appears some docs on sanitizer etc, but I would like to request a complete Jython API documentation for the rest of these tools.
It seems the whole functionality is exposed through Jython, and I'm able to dir() my way through one object at a time, but it's a tedious process without a roadmap.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing Jython API documentation for the Importer tool and the available sanitizer documentation. Inventory the remaining Jython-exposed tools, including timeshifter and transposer, and map their public objects and usage. Done means the other tools have comparable API documentation and a roadmap for navigating them.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100