Introduce formal principle documentation to support contrib changes#3768
Introduce formal principle documentation to support contrib changes#3768mrmundt merged 28 commits intoPyomo:mainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3768 +/- ##
==========================================
- Coverage 89.48% 89.46% -0.02%
==========================================
Files 904 899 -5
Lines 105385 105370 -15
==========================================
- Hits 94299 94266 -33
- Misses 11086 11104 +18
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
blnicho
left a comment
There was a problem hiding this comment.
I have a bunch of minor edit suggestions but overall I think this looks great!
michaelbynum
left a comment
There was a problem hiding this comment.
I'm only about halfway done, but here are a couple comments/questions.
michaelbynum
left a comment
There was a problem hiding this comment.
I have some minor comments, but I think this looks great overall.
emma58
left a comment
There was a problem hiding this comment.
This looks nice--I put a lot of ideas in the comments.
| @@ -0,0 +1,20 @@ | |||
| # Pyomo Addons | |||
|
|
|||
| The `pyomo.addons` directory contains **mostly stable extensions** to Pyomo | |||
There was a problem hiding this comment.
| The `pyomo.addons` directory contains **mostly stable extensions** to Pyomo | |
| The `pyomo.addons` directory contains **stable extensions** to Pyomo |
There was a problem hiding this comment.
I disagree. We explicitly say "mostly stable" everywhere else we talk about addons. This was intentional language to follow the idea of "some level of promised stability," but they still might change in small ways.
blnicho
left a comment
There was a problem hiding this comment.
I found an issue with how some of the code snippets are rendered and I have a few minor edit suggestions.
Fixes None but starts to address #2460
Summary/Motivation:
Stage 1 of the changes inside
pyomo.contribis documenting a lot of different development principles that make the change a lot more reasonably understandable. This PR creates the new directories with their basic READMEs as well as creates documentation about our overarching development principles, including a teaser to the upcoming changes incontribas part of their contents.Changes proposed in this PR:
addonsanddevelprinciples.rstdocumentationdoc/OnlineDocs/apiin .gitignore because I have almost accidentally committed those files WAY too many timesLegal Acknowledgement
By contributing to this software project, I have read the contribution guide and agree to the following terms and conditions for my contribution: