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/pretend reading #61

Merged
merged 6 commits into from
May 29, 2024
Merged

Docs/pretend reading #61

merged 6 commits into from
May 29, 2024

Conversation

adolgert
Copy link
Owner

This PR is responsible for ordering the documentation correctly and excising repeated documentation. It is not responsible for getting all the words right in each section and is not responsible for having every necessary section.

I cut a lot that looked repeated or unhelpful. I added sections on GSMP, hierarchical samplers, and distributions with memory.

Does this cut too much? Would you recommend a different order? We can do that.

@adolgert adolgert requested a review from slwu89 May 28, 2024 01:42
@slwu89
Copy link
Collaborator

slwu89 commented May 28, 2024

@adolgert this is great. I think this is the last step before submission to the general repo. I just made a commit which makes a few small edits 662cde4

  • add wikipedia ref to variance reduction in CRN section
  • in gsmp.jl, whatever method Literate/Documenter uses to parse latex doesn't like \mbox, changed to \text
  • in guide.md, slight copy-editing, and added the Haas reference
  • in hierarchical.jl, removed an apparently extraneous sentence
  • in index.md, a copy-edit, and remove the last line after the last markdown list, which for some reason Literate.jl interpreted as wanting to insert an empty code block in the produced .html file

@adolgert adolgert merged commit 7704b7b into main May 29, 2024
7 checks passed
@adolgert adolgert deleted the docs/pretend-reading branch May 29, 2024 00:37
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