Commit 0188831
Replaced space with underscore for proper doc generation (#1256)
Summary:
Seems like spaces in argument names for function documentation remove everything but the last word which lead to confusion reading the docs as both equality and inequality constraints were simply listed as "constraints".
<!--
Thank you for sending the PR! We appreciate you spending the time to make BoTorch better.
Help us understand your motivation by explaining why you decided to make this change.
You can learn more about contributing to BoTorch here: https://github.com/pytorch/botorch/blob/main/CONTRIBUTING.md
-->
## Motivation
Improve documentation
### Have you read the [Contributing Guidelines on pull requests](https://github.com/pytorch/botorch/blob/main/CONTRIBUTING.md#pull-requests)?
(Write your answer here.)
Pull Request resolved: #1256
Test Plan:
(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)
## Related PRs
(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/pytorch/botorch, and link to your PR here.)
Reviewed By: saitcakmak
Differential Revision: D37082593
Pulled By: Balandat
fbshipit-source-id: 5b8d46c866dd572e7f0417b16385074655437f971 parent 10c8f60 commit 0188831
1 file changed
+2
-2
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
75 | 75 | | |
76 | 76 | | |
77 | 77 | | |
78 | | - | |
| 78 | + | |
79 | 79 | | |
80 | 80 | | |
81 | | - | |
| 81 | + | |
82 | 82 | | |
83 | 83 | | |
84 | 84 | | |
| |||
0 commit comments