Skip to content

Commit cff39eb

Browse files
committed
Add convention about printing to stdout
1 parent 6999a91 commit cff39eb

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

doc/OnlineDocs/principles.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,11 @@ up, so please refer regularly for updates:
158158
* **Circular imports:** Avoid importing from ``pyomo.core`` into any module
159159
in ``pyomo.common`` due to the potential for circular imports.
160160

161+
* **Print statements:** Avoid printing directly to ``stdout``. Pyomo is a
162+
library, not an application, and copious output can interfere with downstream
163+
tools and workflows. Use the appropriate logger instead. Print
164+
information only when the user has enabled or requested it.
165+
161166
* **Pull Request naming:** Pull Request titles are added to the CHANGELOG
162167
and the release notes. The Pyomo development team reserves the right to
163168
alter titles as appropriate to ensure they fit the look and feel of

0 commit comments

Comments
 (0)