cyclus / cyclus/cyclus.github.com

Do we want to add more information about the `solution_priority` part of building a commodity?

Open
#428 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Sub-issue of #427. In the source/user/tutorial/add_commod_recipe.rst file, we talk about the solution priority for the commodities, and defining that block of an input file. Do we still want to include this part of the tutorial? If so, I think we should explain what this means more. I don't think I actually know what it means, so I can't add any more detail.

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.

Research direction

Start with source/user/tutorial/add_commod_recipe.rst and review the section covering the solution_priority block, then read parent issue #427 for context. Determine whether this tutorial section should remain; if it does, the work is done when the meaning of solution_priority is explained clearly, otherwise the section's removal is agreed.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.