Skip to content
This repository has been archived by the owner on Sep 30, 2024. It is now read-only.

Library description is a chore to read, needs rewriting. #19

Open
esuomi opened this issue Jan 20, 2023 · 3 comments
Open

Library description is a chore to read, needs rewriting. #19

esuomi opened this issue Jan 20, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@esuomi
Copy link
Owner

esuomi commented Jan 20, 2023

The description blurb until v1.0.0 was

Muotti is a graph based value transformer library which aims to solve value transformation by utilizing a digraph of known transformations to produce a transformer chain which is then used to perform the actual transformation.

and after that I've changed it to

Muotti is a graph based value transformer library which aims to solve complex value transformation by utilizing a digraph of known transformation steps to produce a final transformer chain which performs the transformation.

This is, however, a terribly self-repeating mouthful. While technically correct and complete, the more I look at it, the less I like it. So please, if you're better than me at describing things in English, please pitch in! :)

@esuomi esuomi added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Jan 20, 2023
@the-amazing-atharva
Copy link

Hey there!!

I am a beginner but tried to rearrange the words :

Muotti , a graph-based value transformer library , uses a digraph of well-known transformations to create a transformer chain,
which is then utilised to carry out the actual transformation, in order to solve the value transformation problem.

If this is fine, I would like to raise a PR to make the changes

@esuomi
Copy link
Owner Author

esuomi commented Jan 21, 2023

The good bit about that is that it's not as repetitive but the ending doesn't really land for me either. Muotti doesn't entirely solve the problem IMHO, it's just a way to arrive at a result. Yes, very semantic and nuanced, I know, but to me that kinda matters :)

@the-amazing-atharva
Copy link

Thanks for the reply!

Glad to be a part of the conversation, but tbh I dont know anything about the library as of yet so just looked at the paragraph for its face value.

Hope you will find the suitable description :)

@esuomi esuomi removed the help wanted Extra attention is needed label Mar 18, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants