docs: Update logging docs [skip tests] #4780
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
the
documentation
Collaborator
Author
|
Earlier: 
Now: 
|
hpohekar
requested review from
mayankansys,
prmukherj and
seanpearsonuk
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances the PyFluent logging documentation by adding practical usage examples. The existing logging documentation only provided a brief overview and referenced external Python logging resources, but lacked concrete examples of how to use PyFluent's logging features.
Key Changes:
- Added code examples demonstrating how to enable logging, set logging levels, configure file logging, and manage individual loggers
- Created a changelog entry documenting this documentation update
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| doc/source/user_guide/log.rst | Added five code examples showing common logging operations including enabling logging, setting global level, file configuration, and logger management |
| doc/changelog.d/4780.documentation.md | Added changelog entry for the logging documentation update |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
prmukherj
approved these changes
Jan 2, 2026
seanpearsonuk
approved these changes
Jan 5, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
Logging usage were missing.
Change Summary
Logging usage have been added.
Rationale
User can use this information to use PyFluent logging.
Impact
Logging docs.