cyclus / cyclus/cyclus.github.com
use underscore in tutorial commodity names
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8
- Forks
- 33
- PR merge metrics
- No merged PRs in 30d
Description
The tutorial recommends commodity names with a dash (-) but this causes an error when cycles uses this name to compose an SQL table. These should be changed to underscore.
Documentation should be updated to warn against using dashes.
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
Start by locating the tutorial pages that recommend commodity names with dashes and review how those names are used to compose SQL tables. Update the examples to use underscores and add a warning against dashes; the tutorial should no longer promote names that cause the reported SQL error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- sql
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100