use underscore in tutorial commodity names

Open
#324 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
sql
Domain
databases, documentation

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.

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.

Dominant language
Python
Stars
8
Forks
33
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from cyclus/cyclus.github.com

All issues in cyclus/cyclus.github.com

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.