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

Implement JOSS reviewer comments regarding documentation #253

Merged

Conversation

fxjung
Copy link
Member

@fxjung fxjung commented Mar 11, 2024

  • Bumped black version
  • Fixed bug in SimulationSet which prevented it to fail with a bang when contradicting parameters were supplied
  • Added quick-start section and contributions gist to the README
  • Updated and improved SimulationSet docs
  • Added rough guide on how to write your own (Python) dispatcher
  • Improved installation instructions slightly

This partially fixes #252 and closes #251.

@fxjung fxjung linked an issue Mar 11, 2024 that may be closed by this pull request
4 tasks
Copy link

github-actions bot commented Mar 11, 2024

Unit Test Results

117 tests  ±0   113 ✅ ±0   37s ⏱️ +2s
  1 suites ±0     4 💤 ±0 
  1 files   ±0     0 ❌ ±0 

Results for commit 539b02d. ± Comparison against base commit 571281a.

♻️ This comment has been updated with latest results.

@fxjung fxjung marked this pull request as ready for review March 12, 2024 10:22
@fxjung fxjung requested a review from debsankha as a code owner March 12, 2024 10:22
@fxjung fxjung merged commit 6a8c0a2 into master Mar 12, 2024
4 checks passed
@fxjung fxjung deleted the 252-implement-joss-reviewer-comments-regarding-documentation branch March 12, 2024 10:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant