Some corrections needed in documentation

Open Beginner friendly
  • Is something wrong?
#17 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
68/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Domain
documentation

Research direction

Review the specified passages in README.md and Doc/UseCases.md, checking each suggested wording change against its context. Pay special attention to the transition example: the issue's stated parenthesis problem and proposed correction appear inconsistent. Done means the documentation typos and unclear wording are corrected without introducing a syntax error in the example.

Written by the indexing model from the issue text.

Description

documentation good first issue

File README.md

In the introduction

- Parsing structured text formats (used for example in compilers or reading >> datas << from files)

The word 'datas' in incorrect and is always 'data'

- Parsing structured text formats (used for example in compilers or reading >> data << from files)

Section Creating states and transitions

  1. Active state

This state automaton is an implementation of IAutomaton with one >> current << state at a time

'active' is more adequate than 'current' for this line.

This state automaton is an implementation of IAutomaton with one >> active << state at a time

  1. Triple parenthesis

stateA.AddTransition(new Transition(tokenB, stateB))

There are 3 closing parenthesis at the end of the line, but the last one has no corresponding opening parenthesis.

stateA.AddTransition(new Transition(tokenB, stateB)))

File Doc/UseCases.md

UseCases.md

Under section Configuration with interface

The automaton can be seen as a graph with nodes and leaves, where nodes are states asking the user about a field to edit and each field has a leave node to set a new value. For better understanding,, the graph may have the same structure >> has << the configuration.

This sentence is unclear and contains typos (understanding,,, has instead of as). It should be:

The automaton can be seen as a graph with nodes and leaves, where nodes are states asking the user about the value of a field and leaves are states associated to a field that set a new value for it. For better understanding, the graph may have the same structure >> as << the configuration.

Dominant language
C#
Stars
0
Forks
1
Avg merge
1h 1m
Merged PRs (30d)
4

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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 Natvs/Nt.Automaton

All issues in Natvs/Nt.Automaton

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.