Bläddra i källkod

Minor changes to docs

Mohammed Anas 2 år sedan
förälder
incheckning
a4d6d2668b
4 ändrade filer med 11 tillägg och 11 borttagningar
  1. 5 5
      README.md
  2. 2 2
      assets/reasons-for-rewriting-in-rust.md
  3. 2 2
      book/src/tutorial.md
  4. 2 2
      book/src/type-system.md

+ 5 - 5
README.md

@@ -33,7 +33,7 @@ Numbat has a static type system where physical dimensions like `Length` and `Tim
 Definitions of constants and functions can optionally contain type annotations that will be statically enforced.
 Definitions of constants and functions can optionally contain type annotations that will be statically enforced.
 If the types are not specified, they will be inferred (`Speed`, `Money` and `Frequency` in the screenshot).
 If the types are not specified, they will be inferred (`Speed`, `Money` and `Frequency` in the screenshot).
 
 
-See [this article](https://numbat.dev/doc/type-system.html) to learn more about Numbats type system.
+See [this article](https://numbat.dev/doc/type-system.html) to learn more about Numbat's type system.
 </details>
 </details>
 
 
 <details>
 <details>
@@ -56,7 +56,7 @@ And unit expressions are simplified using various heuristics (`15 km/h * 30 min
 </summary>
 </summary>
 <p></p>
 <p></p>
 
 
-Numbats [standard library](https://numbat.dev/doc/prelude.html) comes with a large number of physical dimensions and units (SI, US Customary, Imperial, Nautical, Astronomical, Atomic, Nuclear, …).
+Numbat's [standard library](https://numbat.dev/doc/prelude.html) comes with a large number of physical dimensions and units (SI, US Customary, Imperial, Nautical, Astronomical, Atomic, Nuclear, …).
 See [this reference page](https://numbat.dev/doc/list-units.html) for a complete overview.
 See [this reference page](https://numbat.dev/doc/list-units.html) for a complete overview.
 It also contains a lot of [mathematical and physical constants](https://numbat.dev/doc/list-constants.html)
 It also contains a lot of [mathematical and physical constants](https://numbat.dev/doc/list-constants.html)
 as well as a large range of [pre-defined functions](https://numbat.dev/doc/list-functions.html).
 as well as a large range of [pre-defined functions](https://numbat.dev/doc/list-functions.html).
@@ -68,7 +68,7 @@ as well as a large range of [pre-defined functions](https://numbat.dev/doc/list-
 </summary>
 </summary>
 <p></p>
 <p></p>
 
 
-Numbats parser never tries to be "smart" on syntactically incorrect input.
+Numbat's parser never tries to be "smart" on syntactically incorrect input.
 This means you will either get a (descriptive) error message, or you can trust the result of your calculation.
 This means you will either get a (descriptive) error message, or you can trust the result of your calculation.
 </details>
 </details>
 
 
@@ -98,7 +98,7 @@ readline interface, including all the usual features like a command history, Ctr
 </summary>
 </summary>
 <p></p>
 <p></p>
 
 
-The whole system of physical dimensions and units is specified Numbats standard library, which is
+The whole system of physical dimensions and units is specified Numbat's standard library, which is
 [written in the Numbat language](https://github.com/sharkdp/numbat/tree/master/numbat/modules) itself. It is therefore
 [written in the Numbat language](https://github.com/sharkdp/numbat/tree/master/numbat/modules) itself. It is therefore
 easily extensible by [providing a `init.nbt` file](https://numbat.dev/doc/cli-customization.html). For example,
 easily extensible by [providing a `init.nbt` file](https://numbat.dev/doc/cli-customization.html). For example,
 a single line (`unit bathtub = 150 L`) is usually enough to add a new unit. Users can even choose to write their
 a single line (`unit bathtub = 150 L`) is usually enough to add a new unit. Users can even choose to write their
@@ -160,7 +160,7 @@ cargo test
 
 
 ### Working on the `prelude`
 ### Working on the `prelude`
 
 
-If you are working on [Numbats standard library](numbat/modules/), it is convenient to point
+If you are working on [Numbat's standard library](numbat/modules/), it is convenient to point
 the `NUMBAT_MODULES_PATH` environment variable to the `numbat/modules/` folder. This way,
 the `NUMBAT_MODULES_PATH` environment variable to the `numbat/modules/` folder. This way,
 you don't have to recompile Numbat to see your changes.
 you don't have to recompile Numbat to see your changes.
 
 

+ 2 - 2
assets/reasons-for-rewriting-in-rust.md

@@ -10,6 +10,6 @@
       - Being able to define constants and the whole unit system in the language itself (https://numbat.dev/doc/prelude.html)
       - Being able to define constants and the whole unit system in the language itself (https://numbat.dev/doc/prelude.html)
       - Much better error messages
       - Much better error messages
       - Support for notepad-style computations (Mathematica/Jupyter style)
       - Support for notepad-style computations (Mathematica/Jupyter style)
-  - The PureScript implementation is *slow*. Numbats Rust-based parser & interpreter is orders of magnitude faster. Not just
+  - The PureScript implementation is *slow*. Numbat's Rust-based parser & interpreter is orders of magnitude faster, not just
     on the command-line (startup speed!) but also on the Web (via WASM)
     on the command-line (startup speed!) but also on the Web (via WASM)
-  - I always wanted to experiment with WASM and Numbat was a perfect excuse for this.
+  - I've always wanted to experiment with WASM and Numbat was a perfect excuse for this.

+ 2 - 2
book/src/tutorial.md

@@ -20,12 +20,12 @@ let molar_mass = 40 g / mol
 
 
 New constants are [introduced with the `let` keyword](./constant-definitions.md). We
 New constants are [introduced with the `let` keyword](./constant-definitions.md). We
 define these physical quantities with their respective physical units (`years`,
 define these physical quantities with their respective physical units (`years`,
-`percent`, `g / mol`) in order to profit from Numbats unit-safety and unit-conversion
+`percent`, `g / mol`) in order to profit from Numbat's unit-safety and unit-conversion
 features later on.
 features later on.
 
 
 Our first goal is to compute the radioactivity of natural potassium. Instead of dealing with the
 Our first goal is to compute the radioactivity of natural potassium. Instead of dealing with the
 half-life, we want to know the decay rate. When entering the following computation, you can try
 half-life, we want to know the decay rate. When entering the following computation, you can try
-Numbats auto-completion functionality. Instead of typing out `halflife`, just type `half` and press
+Numbat's auto-completion functionality. Instead of typing out `halflife`, just type `half` and press
 `Tab`.
 `Tab`.
 
 
 ``` numbat
 ``` numbat

+ 2 - 2
book/src/type-system.md

@@ -79,7 +79,7 @@ fn air_pressure(height: Length) -> Pressure = p0 · (1 - gradient · height / t0
 
 
 ## Generic types
 ## Generic types
 
 
-Numbats type system also supports generic types (type polymorphism).
+Numbat's type system also supports generic types (type polymorphism).
 These can be used for functions that work regardless of the physical dimension of the argument(s).
 These can be used for functions that work regardless of the physical dimension of the argument(s).
 For example, the type signature of the absolute value function is given by
 For example, the type signature of the absolute value function is given by
 ``` numbat
 ``` numbat
@@ -118,7 +118,7 @@ In order to compute the type of `expr1 ^ expr2`, we need to fully *evaluate*
 hypothetical expression like `meter^f()` where `f()` could do *anything*. Maybe even
 hypothetical expression like `meter^f()` where `f()` could do *anything*. Maybe even
 get some input from the user at runtime.
 get some input from the user at runtime.
 
 
-Numbats solution to this problem looks like this: If `expr1` is *not* dimensionless, 
+Numbat's solution to this problem looks like this: If `expr1` is *not* dimensionless,
 we restrict `expr2` to a small subset of allowed operations that can be fully
 we restrict `expr2` to a small subset of allowed operations that can be fully
 evaluated at compile time (similar to `constexpr` expressions in C++, `const`
 evaluated at compile time (similar to `constexpr` expressions in C++, `const`
 expressions in Rust, etc). Expressions like `meter^(2 * (2 + 1) / 3)` are completely
 expressions in Rust, etc). Expressions like `meter^(2 * (2 + 1) / 3)` are completely