atmoos / atmoos/Quantities

Document parsing in the readme files

Open
#109 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
5
Forks
0
Avg merge
6m
Merged PRs (30d)
4

Description

Parsing functions a bit differently to conventional types

## Possibly expected

```csharp
Length twoMetres = Length.Parse("2 m"); // this doesn't exist!
```

## This library

```csharp
var unitRepository = UnitRepository.Create(); // can load other assemblies containing custom units
IParser parser = Parser.Create(unitRepository); // use that to create a parser

Length twoMetres = parser.Parse("2 m");
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the README files and reviewing their current parsing examples. Document the difference between the conventional Length.Parse expectation and this library's UnitRepository, Parser, and IParser usage; the README examples should clearly show how to parse "2 m".

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.