mehta-lab / waveorder

Wave optical models and inverse algorithms for label-agnostic imaging of density & orientation.
BSD 3-Clause "New" or "Revised" License
12 stars 3 forks source link

PR docs #111

Closed talonchandler closed 1 year ago

talonchandler commented 1 year ago

@mattersoflight requested that I generate a markdown file of the #110 PR, so that we can start keeping a curated list of valuable PRs as documentation. This PR adds the initial markdown file to the list.

To generate this file I ran:

export GITHUB_ACCESS_TOKEN=<your-token>
pip install gh2md
gh2md mehta-lab/waveorder waveorder.md --multiple-files
cp ./2023-02-27.110.pr.open.md ~/waveorder/docs/valuable-prs/
talonchandler commented 1 year ago

Worth noting: gh2md captures foldable sections (like the example scripts), but doesn't capture the "Conversations" that don't happen in the main thread.

I don't think this is an enormous loss, since the original PR with all conversations still exists under "closed".