Documentation - Read.me - weirdy weirdo

[c0ncentus]

Documentation - Read.me - weirdy weirdo

[jakub791]

10^^1e308 means 1e308 raised to 1e308 1e308 times.

[jakub791]

And regarding the docs about methods, we could use JSDoc comments so that they appear in your IDE as well.

[c0ncentus]

And regarding the docs about methods, we could use JSDoc comments so that they appear in your IDE as well.

1. Not every method is documented
2. Not every method 100% well documented (or I would say not is 30% documented)
3. you are not supposed to write 10 paragraphs in readme in "I dont't care" mode.
4. it took someone 10 minutes for write a beautifull Readme and make it 100% usable versus 5% (current state).

I really not enjoy to deal with people thinking we are in their head => If i will be a telepath i don't write that.

The package (break_infinity) is (my intuition) ~10-30% well documented... (use depracated documentation + 1 line or 2).

you could put a minimum effort on doing a beautifull readme and reach ~80% rather than thinking of "writting good documentation" ...

If the maintener cares about documentation:

• prefer something like typescript (you can add it also) rather say "I use JsDoc but many times dont make JSDoc or 1 line or 2 .... lol".
• prefer readme rather than writes 1 line or 2 depend of humor. => proof of reliability and engagement.

Jsdoc are good but the uses in break_infity (maybe as well here) is a joke.

So thats why put readme is neccessary: To be forced to be clear but maybe not a skill of the author.
Like in general as we said as dev ... "tests are garbage", that is also "Just an another myth".

[jakub791]

Regarding JSDoc I meant add JSDoc comments as well (and actually for all then methods, not something like how it's now)

[jakub791]

To add something, I like how this example from the readme:

x = new Decimal(123.4567);
y = new Decimal("123456.7e-3");
z = new Decimal(x);
x.equals(y) && y.equals(z) && x.equals(z); // true

uses implicit creation of global variables which is a bad practice

[Patashu]

Yeah the readme is godawful lmao. Writing a better one would take a lot of effort though, not sure I have it in me.

[c0ncentus]

just do simple is enought. as we said "keep it stupid, simple" ...

is just a system of number with operations ...

it must be simple ... general to deeper mechanisme ...
Lot efforts if you have a tons of things in your head and cannot organized them ...
Take 10 minutes per day or 1 day per week and on february it is done ... (or even if you have clear mind .... you just make it in 10 minutes ...)

[MathCookie17]

About your first point: 10^^1e308 is an example of tetration, which is pretty much the defining feature of this library - I feel it can be safely assumed that users of break_eternity know what tetration is, as if they don't, break_eternity probably isn't what they're looking for.