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

Write some docs #10

Open
1 of 2 tasks
Luapulu opened this issue Feb 11, 2021 · 0 comments
Open
1 of 2 tasks

Write some docs #10

Luapulu opened this issue Feb 11, 2021 · 0 comments
Assignees
@Luapulu

Comments

@Luapulu
Copy link
Contributor

Luapulu commented Feb 11, 2021 •
edited
Loading

I'm thinking at a minimum we should have

  • a basic usage section (start with config -> fieldgen -> signal_calc_init -> get_signal! -> get path / charge size, etc. from setup)
  • docstrings for SigGenSetup, get_signal!, fieldgen, signal_calc_init
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Luapulu Luapulu

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Luapulu