Description
Documentation
Use Simple Language, style guide of documentation:
Don’t use Latin abbreviations like “e.g.” or “i.e.” where English words will do, such as “for example” or “that is.”
I only checked the tutorial and found there are some sentences using e.g.
and i.e.
.
Some of the sentences
In interpreter.html:
E.g., /usr/local/python
is a popular alternative location.
In introduction.html:
The integer numbers (e.g. 2, 4, 20) have type int, the ones with a fractional part (e.g. 5.0, 1.6) have type float.
and uses the j or J suffix to indicate the imaginary part (e.g. 3+5j).
Two or more string literals (i.e. the ones enclosed between quotes)
i.e. it is possible to change their content:
In controlflow.html:
You can use positional parameters with some builtin classes that provide an ordering for their attributes (e.g. dataclasses).
All the keyword arguments passed must match one of the arguments accepted by the function (e.g. actor is not a valid argument for the parrot function), and their order is not important. This also includes non-optional arguments (e.g. parrot(voltage=1000) is valid too).
If we use for example 2, 4, 20
to replace e.g. 2, 4, 20
, it will look longer than before. Maybe we could use something else to replace some short sentences.
Metadata
Metadata
Assignees
Projects
Status