[docs] Update descriptions (#78)

forfudan · web-flow · commit fde190c3c814 · 2025-04-03T23:31:02.000+02:00
This pull request involves several updates to the `DeciMojo` project,
mainly focusing on changing the description of the library from a
"comprehensive" to an "arbitrary-precision" mathematics library and
removing redundant header comments from source files.

Description updates:

*
[`README.md`](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L3-R3):
Updated the description to "an arbitrary-precision decimal and integer
mathematics library for Mojo" and adjusted related text to reflect this
change.
[[1]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L3-R3)
[[2]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L19-L25)
[[3]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L235-R235)
*
[`mojoproject.toml`](diffhunk://#diff-1b0ef62120bccf4c05a76e60e13fe686f33eb92d5897b3f05e0c3f8d737fc5c0L5-R5):
Updated the project description to "an arbitrary-precision decimal and
integer mathematics library for Mojo".

Header comment cleanup:

* Removed redundant header comments from several source files
(`src/decimojo/decimal/arithmetics.mojo`,
`src/decimojo/decimal/comparison.mojo`,
`src/decimojo/decimal/constants.mojo`,
`src/decimojo/decimal/decimal.mojo`,
`src/decimojo/decimal/rounding.mojo`,
`src/decimojo/decimal/special.mojo`).
[[1]](diffhunk://#diff-f2387e2cfccb5298d597dc06df2ad0f7a3b3b06adba58a42e3d76f191dd81047L2-L4)
[[2]](diffhunk://#diff-12a6ed9e6c33dbdaa3748e5d1a8207a1cfc8b6276e60a004ad2c64f021a85ce4L2-L4)
[[3]](diffhunk://#diff-45464c98d8c92c0be8b36702b1858a52a81c685e8532c9ee7c982e836a2c5460L2-L4)
[[4]](diffhunk://#diff-1ab60e45dd70a69f9afe8ce4823a9afd672a608cfc5d5e2047af040ed140eff5L2-L4)
[[5]](diffhunk://#diff-b027dfaa29cb1832f940c4e4146c423fdf730985310d4acf2028273a433c9bb6L2-L4)
[[6]](diffhunk://#diff-0ae815391fe87724efc692a750077ebcffff5fbd2c45e759e3f9ff48c0e4a36aL2-L4)
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # DeciMojo <!-- omit in toc -->
 
-A comprehensive decimal and integer mathematics library for [Mojo](https://www.modular.com/mojo).
+An arbitrary-precision decimal and integer mathematics library for [Mojo](https://www.modular.com/mojo).
 
 **[中文·漢字»](https://zhuyuhao.com/decimojo/docs/readme_zht.html)**　|　**[Repository on GitHub»](https://github.com/forfudan/decimojo)**  | **[Changelog](https://zhuyuhao.com/decimojo/docs/changelog.html)**
 
@@ -16,13 +16,13 @@ A comprehensive decimal and integer mathematics library for [Mojo](https://www.m
 
 ## Overview
 
-DeciMojo provides a comprehensive decimal and integer mathematics library for Mojo, delivering exact calculations for financial modeling, scientific computing, and applications where floating-point approximation errors are unacceptable. Beyond basic arithmetic, the library includes advanced mathematical functions with guaranteed precision.
+DeciMojo provides an arbitrary-precision decimal and integer mathematics library for Mojo, delivering exact calculations for financial modeling, scientific computing, and applications where floating-point approximation errors are unacceptable. Beyond basic arithmetic, the library includes advanced mathematical functions with guaranteed precision.
 
 The core types are:
 
-- A 128-bit fixed-point decimal implementation (`Decimal`) supporting up to 29 significant digits with a maximum of 28 decimal places[^fixed]. It features a complete set of mathematical functions including logarithms, exponentiation, roots, and trigonometric operations.
+- A 128-bit fixed-point decimal implementation (`Decimal`) supporting up to 29 significant digits with a maximum of 28 decimal places[^fixed]. It features a complete set of mathematical functions including logarithms, exponentiation, roots, etc.
+- An arbitrary-precision decimal implementation `BigDecimal` allowing for calculations with unlimited digits and decimal places[^arbitrary].
 - A base-10 arbitrary-precision signed integer type (`BigInt`) and a base-10 arbitrary-precision unsigned integer type (`BigUInt`) supporting unlimited digits[^integer]. It features comprehensive arithmetic operations, comparison functions, and supports extremely large integer calculations efficiently.
-- An arbitrary-precision decimal implementation `BigDecimal` allowing for calculations with unlimited digits and decimal places[^arbitrary]. It is currently under active development.
 
 This repository includes [TOMLMojo](https://github.com/forfudan/decimojo/tree/main/src/tomlmojo), a lightweight TOML parser in pure Mojo. It parses configuration files and test data, supporting basic types, arrays, and nested tables. While created for DeciMojo's testing framework, it offers general-purpose structured data parsing with a clean, simple API.
 
@@ -232,7 +232,7 @@ If you find DeciMojo useful for your research, consider listing it in your citat
 @software{Zhu.2025,
     author       = {Zhu, Yuhao},
     year         = {2025},
-    title        = {A comprehensive decimal and integer mathematics library for Mojo},
+    title        = {An arbitrary-precision decimal and integer mathematics library for Mojo},
     url          = {https://github.com/forfudan/decimojo},
     version      = {0.2.0},
     note         = {Computer Software}
diff --git a/mojoproject.toml b/mojoproject.toml
@@ -2,7 +2,7 @@
 authors = ["ZHU Yuhao 朱宇浩 <dr.yuhao.zhu@outlook.com>"]
 channels = ["https://conda.modular.com/max", "https://repo.prefix.dev/modular-community", "conda-forge"]
 # channels = ["https://conda.modular.com/max-nightly", "https://conda.modular.com/max", "https://repo.prefix.dev/modular-community", "conda-forge"]
-description = "A comprehensive decimal and integer mathematics library for Mojo"
+description = "An arbitrary-precision decimal and integer mathematics library for Mojo"
 license = "Apache-2.0"
 name = "decimojo"
 platforms = ["osx-arm64", "linux-64"]
diff --git a/src/decimojo/decimal/arithmetics.mojo b/src/decimojo/decimal/arithmetics.mojo
@@ -1,7 +1,4 @@
 # ===----------------------------------------------------------------------=== #
-# DeciMojo: A fixed-point decimal arithmetic library in Mojo
-# https://github.com/forfudan/decimojo
-#
 # Copyright 2025 Yuhao Zhu
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
diff --git a/src/decimojo/decimal/comparison.mojo b/src/decimojo/decimal/comparison.mojo
@@ -1,7 +1,4 @@
 # ===----------------------------------------------------------------------=== #
-# DeciMojo: A fixed-point decimal arithmetic library in Mojo
-# https://github.com/forfudan/decimojo
-#
 # Copyright 2025 Yuhao Zhu
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
diff --git a/src/decimojo/decimal/constants.mojo b/src/decimojo/decimal/constants.mojo
@@ -1,7 +1,4 @@
 # ===----------------------------------------------------------------------=== #
-# DeciMojo: A fixed-point decimal arithmetic library in Mojo
-# https://github.com/forfudan/decimojo
-#
 # Copyright 2025 Yuhao Zhu
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
diff --git a/src/decimojo/decimal/decimal.mojo b/src/decimojo/decimal/decimal.mojo
@@ -1,7 +1,4 @@
 # ===----------------------------------------------------------------------=== #
-# DeciMojo: A fixed-point decimal arithmetic library in Mojo
-# https://github.com/forfudan/decimojo
-#
 # Copyright 2025 Yuhao Zhu
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
diff --git a/src/decimojo/decimal/rounding.mojo b/src/decimojo/decimal/rounding.mojo
@@ -1,7 +1,4 @@
 # ===----------------------------------------------------------------------=== #
-# DeciMojo: A fixed-point decimal arithmetic library in Mojo
-# https://github.com/forfudan/decimojo
-#
 # Copyright 2025 Yuhao Zhu
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
diff --git a/src/decimojo/decimal/special.mojo b/src/decimojo/decimal/special.mojo
@@ -1,7 +1,4 @@
 # ===----------------------------------------------------------------------=== #
-# DeciMojo: A fixed-point decimal arithmetic library in Mojo
-# https://github.com/forfudan/decimojo
-#
 # Copyright 2025 Yuhao Zhu
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,4 @@`
`1`	`1`	`# ===----------------------------------------------------------------------=== #`
`2`		`-# DeciMojo: A fixed-point decimal arithmetic library in Mojo`
`3`		`-# https://github.com/forfudan/decimojo`
`4`		`-#`
`5`	`2`	`# Copyright 2025 Yuhao Zhu`
`6`	`3`	`#`
`7`	`4`	`# Licensed under the Apache License, Version 2.0 (the "License");`