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 Sphinx warnings #2712

Merged
merged 1 commit into from
Jan 31, 2023
Merged

Fix Sphinx warnings #2712

merged 1 commit into from
Jan 31, 2023

Conversation

blnicho
Copy link
Member

@blnicho blnicho commented Jan 31, 2023

Summary/Motivation:

Fixing sphinx warnings that have been accumulating from docstring formatting issues. I also made a slight change to the docs configuration to display todo blocks in docstrings. Remaining warnings will be fixed in #2711

Changes proposed in this PR:

  • Fix sphinx formatting issues in several docstrings
  • Display todo blocks that appear in docstrings

Legal Acknowledgement

By contributing to this software project, I have read the contribution guide and agree to the following terms and conditions for my contribution:

  1. I agree my contributions are submitted under the BSD license.
  2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

@blnicho blnicho merged commit 0ef8cde into Pyomo:main Jan 31, 2023
@blnicho blnicho deleted the fix-sphinx-warnings branch January 31, 2023 23:50
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