cyclus / cyclus/cyclus.github.com

typo on the http://fuelcycle.org/user/tutorial/add_proto.html

Open
#310 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

The template for the Source archetype is of the form:
facility
name name name
config
Archetype
outcommod>outcommod</outcommod


Has to be as below, otherwise confusing:

facility
name name name
config
Source
outcommod>outcommod
Source
config
facility

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

Open the tutorial page at http://fuelcycle.org/user/tutorial/add_proto.html and compare the Source archetype template with the correction in the issue body. Fix the displayed template so the Source tags and outcommod element match the proposed form, then verify the rendered page is no longer confusing.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.