DOC: Fix toc in documentation and a typo (#255)

* Fix toc in documentation and typo. * Uncommented pre-commit hook --------- Co-authored-by: Aviraj Saha <[email protected]>
neutrinoceros · Sep 2, 2024 · 81082ff · 81082ff
1 parent fd1f8e0
commit 81082ff
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 6 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -22,11 +22,11 @@ repos:
 # still using removed and deprecated parts of the Python stdlib
 # see https://github.com/ekalinin/nodeenv/issues/343
 # see https://github.com/ekalinin/nodeenv/issues/341
-# - repo: https://github.com/Lucas-C/pre-commit-hooks-nodejs
-#   rev: v1.1.2
-#   hooks:
-#   - id: markdown-toc
-#     files: README.md
+- repo: https://github.com/Lucas-C/pre-commit-hooks-nodejs
+  rev: v1.1.2
+  hooks:
+  - id: markdown-toc
+    files: README.md
 
 - repo: https://github.com/astral-sh/ruff-pre-commit
   rev: v0.5.0

diff --git a/README.md b/README.md
@@ -28,6 +28,7 @@ GPGI stands for **G**eneric **P**article + **G**rid data **I**nterface
   * [Weight fields (Depositing intensive quantities)](#weight-fields-depositing-intensive-quantities)
   * [Count Sorting](#count-sorting)
 - [Deposition algorithm](#deposition-algorithm)
+- [Thread safety](#thread-safety)
 
 <!-- tocstop -->
 
@@ -84,7 +85,7 @@ Their signature need to be compatible with `gpgi.types.DepositionMethodT`.
 
 An important step in performing deposition is to associate particle indices to cell indices. This step is called "particle indexing".
 In directions where the grid is uniformly stepped (if any), indexing a particle is an O(1) operation.
-In the more general case, indexing is performed by bisection, which is a O(log(nx))) operation (where nx represents the number of cells in the direction of interest).
+In the more general case, indexing is performed by bisection, which is a O(log(nx)) operation (where nx represents the number of cells in the direction of interest).
 
 
 ## Usage