[MahishaKannan]

Summary

• Clarify the distinction between the output of help() and a function's documentation.
• Keep the wording beginner-friendly and limited to the existing explanation.

Closes #1125

[github-actions]

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

• 🎯 correct output
• 🖼️ correct figures
• ❓ new warnings
• ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/swcarpentry/python-novice-inflammation/compare/md-outputs..md-outputs-PR-1129

The following changes were observed in the rendered markdown documents:

 01-intro.md | 2 +-
 md5sum.txt  | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2026-10-13 15:15:49 +0000

[Shorla]

Hi @MahishaKannan, thank you so much for taking the time to work on this issue.

@noatgnu @ineelhere, I want a second opinion before merging this PR.

[noatgnu]

Should be ok to merge for me @Shorla

[MahishaKannan]

Ok it's your wish if you want to merge @Shorla ok for me but I think I worked for it it's ok

[Shorla]

Should be ok to merge for me @Shorla

Thank you! @noatgnu