[Feature]: docstrings for NamedTrajectory struct and consttructors - Githubissues

kestrelquantum / NamedTrajectories.jl

Efficient Handling of Trajectories with User Defined Named Components

MIT License

6 stars 4 forks source link

[Feature]: docstrings for NamedTrajectory struct and consttructors #39

Closed aarontrowbridge closed 1 month ago

aarontrowbridge commented 1 month ago

Feature Description

We need docstrings attached to the struct and methods in src/struct_named_trajectory

Implementation requirements

add docstrings to all of the functions in src/struct_named_trajectory using the Blue style guidelines
populate the docs file docs/literate/man/constructors.jl with examples using Literate.jl, see the docs script docs/literate/quickstart.jl for reference

Importance

1 (lowest)

What does this feature affect?

[ ] construction
[ ] methods
[ ] plotting
[ ] documentation
[ ] tests
[ ] other (please specify below)

Other information

No response

ErikQQY commented 1 month ago

This issue need assignment so that unitaryhack can locate contributor, related pull requests: #40

ErikQQY commented 4 weeks ago

Could you also assign me this issue?😄 @aarontrowbridge