Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add docstrings #34

Closed
carljohnsen opened this issue Feb 15, 2023 · 1 comment
Closed

Add docstrings #34

carljohnsen opened this issue Feb 15, 2023 · 1 comment

Comments

@carljohnsen
Copy link
Collaborator

This will make documentation better!
carljohnsen added a commit that referenced this issue Feb 17, 2023
@carljohnsen
#34 Added example docstring in geometry.hh
ec9b2f6
carljohnsen added a commit that referenced this issue Sep 12, 2024
@carljohnsen
#34 Added docstrings for config.constants
18b402b
carljohnsen added a commit that referenced this issue Sep 12, 2024
@carljohnsen
#34 Added docstrings to config.paths.
66fe450
carljohnsen added a commit that referenced this issue Sep 12, 2024
@carljohnsen
#34 Added docstrings for the config module.
0e07f9d
carljohnsen added a commit that referenced this issue Sep 12, 2024
@carljohnsen
#34 Updated the docstrings in lib.py.distributions to be consistent a…
d1f9fdc 
…nd match Python doctstring format.
carljohnsen added a commit that referenced this issue Sep 12, 2024
@carljohnsen
#34 Added docstrings to lib.py.esrf_read
af1efb3
carljohnsen added a commit that referenced this issue Sep 13, 2024
@carljohnsen
#34 Added missing datatype on the numpy/bohrium/jax arrays in the doc…
f1e7277 
…string.
carljohnsen added a commit that referenced this issue Sep 13, 2024
@carljohnsen
#34 Added docstrings to lib.py.helpers.
5cca673
carljohnsen added a commit that referenced this issue Sep 13, 2024
@carljohnsen
#34 Add shebang and module docstring to distributions.py and helpers.py
d4d5e65
carljohnsen added a commit that referenced this issue Sep 13, 2024
@carljohnsen
#34 Added docstrings to lib.py.piecewise_cubic.py
7626c48
carljohnsen added a commit that referenced this issue Sep 13, 2024
@carljohnsen
#34 Added docstrings to lib.py.resample.
27bc0d0
carljohnsen added a commit that referenced this issue Sep 13, 2024
@carljohnsen
#34 Added docstring to the lib.cpp.*.analysis header.
318e3a2
carljohnsen added a commit that referenced this issue Sep 16, 2024
@carljohnsen
#34 Added docstring to boilerplate.hh
9cc1805
carljohnsen added a commit that referenced this issue Sep 16, 2024
@carljohnsen
#34 Added docstring to bitpacking.hh
f9285f1
carljohnsen added a commit that referenced this issue Sep 16, 2024
@carljohnsen
#34 Added docstring to analysis-pybind.cc
b54a253
carljohnsen added a commit that referenced this issue Sep 16, 2024
@carljohnsen
#34 Missing truetype marks on variable names.
3dbf7a0
carljohnsen added a commit that referenced this issue Sep 16, 2024
@carljohnsen
#34 Added doctstring to io.hh
879f9c0
carljohnsen added a commit that referenced this issue Sep 16, 2024
@carljohnsen
#34 Added docstring to io-pybind.cc. Still missing Python docstrings …
6fc3ead 
…though.
carljohnsen added a commit that referenced this issue Sep 16, 2024
@carljohnsen
#34 Added docstrings to connected_components.hh
1e81000
carljohnsen added a commit that referenced this issue Sep 16, 2024
@carljohnsen
#34 Added doctstrings to connected_components-pybind.cc
81c0eea
carljohnsen added a commit that referenced this issue Sep 16, 2024
@carljohnsen
#34 Added missing file docstrings
9763572
carljohnsen added a commit that referenced this issue Sep 17, 2024
@carljohnsen
#34 Ensured that the connected_components header file function signat…
f6d87b0 
…ures matches the implementation signatures.
carljohnsen added a commit that referenced this issue Sep 17, 2024
@carljohnsen
#34 Added docstrings to datatypes.hh
113c032
carljohnsen added a commit that referenced this issue Sep 17, 2024
@carljohnsen
#34 Added docstrings to diffusion.hh
8942037
carljohnsen added a commit that referenced this issue Sep 17, 2024
@carljohnsen
#34 Added docstrings to the diffusion implementations.
0bc1c89
carljohnsen added a commit that referenced this issue Sep 17, 2024
@carljohnsen
#34 Added docstrings to the diffusion python bindings.
26fe9b4
carljohnsen added a commit that referenced this issue Sep 17, 2024
@carljohnsen
#34 Added docstring to general.hh
b67ee13
carljohnsen added a commit that referenced this issue Sep 17, 2024
@carljohnsen
#34 Added file docstrings to the general implementations.
1139ca4
carljohnsen added a commit that referenced this issue Sep 17, 2024
@carljohnsen
#34 Added docstring to the general python bindings
827373e
carljohnsen added a commit that referenced this issue Sep 17, 2024
@carljohnsen
#34 Added docstrings to geometry.hh
cc8bac5
carljohnsen added a commit that referenced this issue Sep 17, 2024
@carljohnsen
#34 Added docstrings to morphology-pybind
3678932
carljohnsen added a commit that referenced this issue Sep 17, 2024
@carljohnsen
#34 Added file docstring for 0100
cd4eeef
carljohnsen added a commit that referenced this issue Sep 17, 2024
@carljohnsen
#34 Added file docstring to 0200
592f7c7
carljohnsen added a commit that referenced this issue Sep 17, 2024
@carljohnsen
#34 Added file docstring to 0225
6d16a1d
carljohnsen added a commit that referenced this issue Sep 17, 2024
@carljohnsen
#34 Added file docstring for 0250
9b33e9c
carljohnsen added a commit that referenced this issue Sep 17, 2024
@carljohnsen
#34 Added docstrings for the functions in 0300
baa6983
carljohnsen added a commit that referenced this issue Sep 17, 2024
@carljohnsen
#34 Add docstrings to 0400
a7067ab
carljohnsen added a commit that referenced this issue Sep 17, 2024
@carljohnsen
#34 Added file docstring to 0500
1d47545
carljohnsen added a commit that referenced this issue Sep 17, 2024
@carljohnsen
#34 Added file docstring to 0600
ada22c9
carljohnsen added a commit that referenced this issue Sep 17, 2024
@carljohnsen
#34 Added docstrings to 0700
35b403a
carljohnsen added a commit that referenced this issue Sep 17, 2024
@carljohnsen
#34 Added docstrings to the morphology functions in helpers
33d53a9
carljohnsen added a commit that referenced this issue Sep 18, 2024
@carljohnsen
#34 Added docstrings to 0750
d5e4106
carljohnsen added a commit that referenced this issue Sep 18, 2024
@carljohnsen
#34 Added docstrings to 0800
31d6333
carljohnsen added a commit that referenced this issue Sep 18, 2024
@carljohnsen
#34 Added docstrings to 0900
054a078
carljohnsen added a commit that referenced this issue Sep 18, 2024
@carljohnsen
#34 Added docstrings to the gauss_kernel function.
f976465
carljohnsen added a commit that referenced this issue Sep 18, 2024
@carljohnsen
#12 General cleanup in 0950
70bafdf 
#34 Added file docstrings to 0950
carljohnsen added a commit that referenced this issue Sep 18, 2024
@carljohnsen
#12 General cleanup in 0975
9bc4955 
#34 Added file docstring to 0975
carljohnsen added a commit that referenced this issue Sep 18, 2024
@carljohnsen
#34 Added docstrings to 1000
d4664bf
carljohnsen added a commit that referenced this issue Sep 18, 2024
@carljohnsen
#34 Added docstrings to 1050
26f902c
carljohnsen added a commit that referenced this issue Sep 18, 2024
@carljohnsen
#34 Added docstrings to 1100
19bd7e0
carljohnsen added a commit that referenced this issue Sep 18, 2024
@carljohnsen
#34 Added docstrings to 1200
8877d53
carljohnsen added a commit that referenced this issue Sep 18, 2024
@carljohnsen
#34 Added docstrings to 1250
fd59df5
carljohnsen added a commit that referenced this issue Sep 18, 2024
@carljohnsen
#34 Added docstrings to 1300
8dec109
carljohnsen added a commit that referenced this issue Sep 18, 2024
@carljohnsen
#34 Added docstrings to 1500
ddbe852
carljohnsen added a commit that referenced this issue Sep 18, 2024
@carljohnsen
#12 General cleanup in 1550
6ae4ed7 
#34 Added file docstring to 1550
carljohnsen added a commit that referenced this issue Sep 18, 2024
@carljohnsen
#12 General cleanup in 1600
c49747c 
#34 Added file docstring to 1600
carljohnsen added a commit that referenced this issue Sep 18, 2024
@carljohnsen
#12 General cleanup in 1700
beaca3b 
#34 Added file docstring to 1700
@carljohnsen
Copy link
Collaborator Author

Docstrings have been added to everything in the src/ folder (except for tests, which are due for a rewrite: #16). In other words, everything in use should have a docstring.

carljohnsen added a commit that referenced this issue Sep 20, 2024
@carljohnsen
Fixed various compilation errors introduced by #12 and #34
7644a26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@carljohnsen