Skip to content

Simplify one-line docstrings for snippets#293

Merged
deppen8 merged 2 commits intodatacarpentry:mainfrom
deppen8:291-snippet-docstring-formatting
Aug 16, 2023
Merged

Simplify one-line docstrings for snippets#293
deppen8 merged 2 commits intodatacarpentry:mainfrom
deppen8:291-snippet-docstring-formatting

Conversation

@deppen8
Copy link
Copy Markdown
Contributor

@deppen8 deppen8 commented Aug 15, 2023

Closes #291

This PR removes the * from the triple-quoted docstrings in some of the code snippets. This should hopefully make them look more like the Python standards set it PEP 257 that learners are likely encounter outside the lesson.

The PR also removes some extra blank lines that my Markdown linter didn't like.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Aug 15, 2023

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/datacarpentry/image-processing/compare/md-outputs..md-outputs-PR-293

The following changes were observed in the rendered markdown documents:

 02-image-basics.md   | 16 +++++-----------
 03-skimage-images.md | 45 +++++++--------------------------------------
 edge-detection.md    | 31 +++++++++----------------------
 md5sum.txt           |  6 +++---
 4 files changed, 24 insertions(+), 74 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 2023-08-16 02:50:49 +0000

github-actions bot pushed a commit that referenced this pull request Aug 15, 2023
Copy link
Copy Markdown
Member

@tobyhodges tobyhodges left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Thanks, @deppen8. I have suggested only one change, to fix a typo that went undetected until now.

Co-authored-by: Toby Hodges <tbyhdgs@gmail.com>
@deppen8
Copy link
Copy Markdown
Contributor Author

deppen8 commented Aug 16, 2023

I have suggested only one change, to fix a typo that went undetected until now.

Ha! How did I miss that while editing that exact line? Done.

github-actions bot pushed a commit that referenced this pull request Aug 16, 2023
@deppen8 deppen8 merged commit 0852382 into datacarpentry:main Aug 16, 2023
@deppen8 deppen8 deleted the 291-snippet-docstring-formatting branch August 16, 2023 02:52
github-actions bot pushed a commit that referenced this pull request Aug 16, 2023
Auto-generated via {sandpaper}
Source  : 0852382
Branch  : main
Author  : Jacob Deppen <deppen.8@gmail.com>
Time    : 2023-08-16 02:52:31 +0000
Message : Merge pull request #293 from deppen8/291-snippet-docstring-formatting

Simplify one-line docstrings for snippets
github-actions bot pushed a commit that referenced this pull request Aug 16, 2023
Auto-generated via {sandpaper}
Source  : dd9cf28
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2023-08-16 02:54:04 +0000
Message : markdown source builds

Auto-generated via {sandpaper}
Source  : 0852382
Branch  : main
Author  : Jacob Deppen <deppen.8@gmail.com>
Time    : 2023-08-16 02:52:31 +0000
Message : Merge pull request #293 from deppen8/291-snippet-docstring-formatting

Simplify one-line docstrings for snippets
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.

Code snippet docstring formatting

2 participants