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

Fix docs on how to select using the bls parameter #383

Merged
merged 1 commit into from
Feb 18, 2022
Merged

Conversation

bhazelton
Copy link
Member

@bhazelton bhazelton commented Feb 14, 2022

Description

Fix errors in documentation on using the select method with the bls parameter.

Note that there is an existing test, test_param_select_bls in test_simsetup.py, that tests that this works as documented in this PR.

Motivation and Context

fixes #333

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Reference simulation update or replacement
  • Documentation change (documentation changes only)
  • Version change
  • Build or continuous integration change

Checklist:

For all pull requests:

Documentation change checklist:

  • Any updated docstrings use the numpy docstring format.
  • If this is a significant change to the readme or other docs, I have checked that they are rendered properly on ReadTheDocs. (you may need help to get this branch to build on RTD, just ask!)

@bhazelton bhazelton added the docs label Feb 14, 2022
@codecov
Copy link

codecov bot commented Feb 14, 2022

Codecov Report

Merging #383 (6c48d92) into main (1f88b96) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #383   +/-   ##
=======================================
  Coverage   99.17%   99.17%           
=======================================
  Files          13       13           
  Lines        2054     2054           
=======================================
  Hits         2037     2037           
  Misses         17       17           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1f88b96...6c48d92. Read the comment docs.

@bhazelton bhazelton requested a review from mkolopanis February 14, 2022 21:49
Copy link
Member

@mkolopanis mkolopanis left a comment

Choose a reason for hiding this comment

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

I approve this message.

@mkolopanis mkolopanis merged commit ff302cc into main Feb 18, 2022
@mkolopanis mkolopanis deleted the fix_select_docs branch February 18, 2022 22:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update documentation for using "select"
2 participants