Imageomics / Imageomics/TaxonoPy
IO inaccuracies in documentation
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 19
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
scientific_nameis a required input field. It may be null, but the column must be present for validation. Current docs describe it as optional, which is misleading as-is.- input columns should mention
source_id - output files documentation implies a
.resolvedand.unsolvedfile will always be written for everyresolvecommand input. Butresolvemight not include.unsolvedif everything that is written goes into.resolved(misleading as-is). Also forgot to mention.forced. --full-rerundoesn't affect common names manifest. This functionality (or lack thereof) should be clarified, and separately decided on whether or not it should exist in some form.
Contributor guide
No contributing guide indexed for this repository
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
Locate the documentation for input columns, resolve outputs, and the --full-rerun option, then verify each statement against the current command behavior. Update the docs to describe nullable-but-required scientific_name, source_id, conditional .resolved/.unsolved outputs, and .forced; record the actual common-names manifest behavior while the separate feature decision is resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100