Skip to content

Commit 6eff6f4

Browse files
dpshelioageorgou
andauthored
✏ suggestions from code-review
Co-authored-by: ageorgou <[email protected]>
1 parent cca0ce7 commit 6eff6f4

File tree

2 files changed

+2
-3
lines changed

2 files changed

+2
-3
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ html/index.html
1010
pdf
1111
*.pyc
1212
*.nbconvert.ipynb
13-
*.html
1413
*.swp
1514
a.out
1615
html/reveal/.DS_Store

ch04packaging/04documentation.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
"| Fortan | [FORD](https://github.com/Fortran-FOSS-Programmers/ford) | [`arange` docs](https://stdlib.fortran-lang.org/interface/arange.html) | [`arange` docstring source](https://github.com/fortran-lang/stdlib/blob/d14fca8e7cc36ed5f6f84d2bf576c91c2e54eb07/src/stdlib_math.fypp#L276-L290) |\n",
7575
"| Rust | [rustdoc](https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html) | [`Matrix` docs](https://docs.rs/nalgebra/0.18.0/nalgebra/base/struct.Matrix.html) | [`Matrix` docstring source](https://github.com/dimforge/nalgebra/blob/8ea8ac70d5ad4bae865e6246a48455bf0b3fa3d2/src/base/matrix.rs#L59-L157) |\n",
7676
"\n",
77-
"[Breathe](https://breathe.readthedocs.io/en/latest/) can be used to make Sphinx and Doxygen work together (good to keep documentation, for example, of a c++ project that includes python bindings). [roxygen2](https://cran.r-project.org/web/packages/roxygen2/vignettes/roxygen2.html) is another good option for R packages.\n",
77+
"[Breathe](https://breathe.readthedocs.io/en/latest/) can be used to make Sphinx and Doxygen work together (good to keep documentation, for example, of a C++ project that includes Python bindings). [roxygen2](https://cran.r-project.org/web/packages/roxygen2/vignettes/roxygen2.html) is another good option for R packages.\n",
7878
"\n",
7979
"\n"
8080
]
@@ -446,7 +446,7 @@
446446
"source": [
447447
"`doctest` is a module included in the standard library. It runs all the code within the docstrings and checks whether the output is what it's claimed on the documentation.\n",
448448
"\n",
449-
"Let's add an example to our greeting function and check it with `doctest`. We are leaving the output with a small typo (missing the close quote `'`) to see what's the type of output we get from `doctest`."
449+
"Let's add an example to our greeting function and check it with `doctest`. We are leaving the output with a small typo (missing the closing quote `'`) to see what's the type of output we get from `doctest`."
450450
]
451451
},
452452
{

0 commit comments

Comments
 (0)