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.

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

Docs/guide manual reference #46

Merged
merged 11 commits into from
Mar 28, 2024
Merged

Docs/guide manual reference #46

merged 11 commits into from
Mar 28, 2024

Conversation

adolgert
Copy link
Owner

This splits documentation into a guide, a manual, and a reference.

  • The guide now has expanded text with a gentle-ish introduction.
  • The manual part is pretty much the same as what was there. Needs work still.
  • The reference is organized, and the docstrings now include the standard form for Documenter.

This uses Literate.jl for one of the guide's examples. Works OK.

@adolgert adolgert requested a review from slwu89 March 27, 2024 12:20
Copy link
Collaborator

@slwu89 slwu89 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adolgert this looks good to me. I made some changes in d2c89d4. I will describe the major changes I did below:

  • in docs/src/distributions.md: changed the wording of how Fleck is introduced to explicitly bring up process vs event-oriented simulations; anyone who knows what JuliaSim is will know those two terms and instantly grasp (hopefully) what Fleck is doing. I also added exaplanation of the CDF/Survival there because otherwise the survival term in the marginal firing probability comes out of nowhere
  • docs/src/guide.md: for some reason the mosquito vs bat metaphor took a while for me to grasp; changed to a metaphor very obviously in the exact same domain. Hopefully it helps.
  • docs/src/simple_board.jl: moved the key type out of the functions so it's only defined once (it's currently defined twice in the code, a bit brittle).

I did not touch develop.md or vas.md as they look like they are still in progress. Thanks for keeping delay.md around; I'm not sure what to do with it, although I am very proud of that figure I made at the top. Perhaps it will live nicely with #45?

Can I suggest that distributions.md move to using Documenter/Literate to produce the graphs? I want to include plots of the CDF/survival and it would be nice to have it all programatically generated from code.

Other things:

  • Can I be added as coauthor/contributor on the package?
  • Your contact email is probably not still the uw.edu one
  • Do you want to link to your counting processes paper somewhere for the adventurous reader? https://arxiv.org/abs/1610.03939

@adolgert
Copy link
Owner Author

Your edits are great, and your suggestions are, too. I'll merge this PR because it's big and then do the suggestions.

@adolgert adolgert merged commit 63f3757 into main Mar 28, 2024
7 checks passed
@slwu89 slwu89 deleted the docs/guide-manual-reference branch April 5, 2024 19:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants