Skip to content

Conversation

@knarrff
Copy link
Contributor

@knarrff knarrff commented Mar 2, 2025

I don't see a reason to use the date format DD-MM-YYYY in the example. Thus: use the standard iso YYYY-MM-DD format instead to show good practice in action.

@github-actions
Copy link

github-actions bot commented Mar 2, 2025

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/carpentries-incubator/python-intermediate-development/compare/md-outputs..md-outputs-PR-447

The following changes were observed in the rendered markdown documents:

 12-virtual-environments.md                     | 73 +++-----------------------
 13-ides.md                                     | 10 ++--
 16-verifying-code-style-linters.md             |  2 +-
 21-automatically-testing-software.md           |  2 +-
 22-scaling-up-unit-testing.md                  |  2 +-
 23-continuous-integration-automated-testing.md | 12 ++---
 33-code-decoupling-abstractions.md             | 30 ++++-------
 41-code-review.md                              | 11 ++--
 43-software-release.md                         | 13 +----
 md5sum.txt                                     | 22 ++++----
 section_1_setting_up_environment.md            |  4 +-
 section_4_collaborative_soft_dev.md            |  2 +-
 12 files changed, 54 insertions(+), 129 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 2025-04-01 09:22:41 +0000

github-actions bot pushed a commit that referenced this pull request Apr 1, 2025
@steve-crouch steve-crouch self-requested a review April 1, 2025 09:25
Copy link
Collaborator

@steve-crouch steve-crouch left a comment

Choose a reason for hiding this comment

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

That's a good catch, thanks for the PR @knarrff .

@steve-crouch steve-crouch merged commit b743890 into carpentries-incubator:main Apr 1, 2025
3 checks passed
github-actions bot pushed a commit that referenced this pull request Apr 1, 2025
Auto-generated via `{sandpaper}`
Source  : b743890
Branch  : main
Author  : Steve Crouch <s.crouch@software.ac.uk>
Time    : 2025-04-01 09:47:37 +0000
Message : Merge pull request #447 from knarrff/iso-date_in_example

use iso-formated date in example
github-actions bot pushed a commit that referenced this pull request Apr 1, 2025
Auto-generated via `{sandpaper}`
Source  : 9600ae5
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-04-01 09:48:31 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : b743890
Branch  : main
Author  : Steve Crouch <s.crouch@software.ac.uk>
Time    : 2025-04-01 09:47:37 +0000
Message : Merge pull request #447 from knarrff/iso-date_in_example

use iso-formated date in example
github-actions bot pushed a commit that referenced this pull request Apr 8, 2025
Auto-generated via `{sandpaper}`
Source  : 9600ae5
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-04-01 09:48:31 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : b743890
Branch  : main
Author  : Steve Crouch <s.crouch@software.ac.uk>
Time    : 2025-04-01 09:47:37 +0000
Message : Merge pull request #447 from knarrff/iso-date_in_example

use iso-formated date in example
github-actions bot pushed a commit that referenced this pull request Apr 15, 2025
Auto-generated via `{sandpaper}`
Source  : 9600ae5
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-04-01 09:48:31 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : b743890
Branch  : main
Author  : Steve Crouch <s.crouch@software.ac.uk>
Time    : 2025-04-01 09:47:37 +0000
Message : Merge pull request #447 from knarrff/iso-date_in_example

use iso-formated date in example
github-actions bot pushed a commit that referenced this pull request Apr 22, 2025
Auto-generated via `{sandpaper}`
Source  : 9600ae5
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-04-01 09:48:31 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : b743890
Branch  : main
Author  : Steve Crouch <s.crouch@software.ac.uk>
Time    : 2025-04-01 09:47:37 +0000
Message : Merge pull request #447 from knarrff/iso-date_in_example

use iso-formated date in example
github-actions bot pushed a commit that referenced this pull request Apr 29, 2025
Auto-generated via `{sandpaper}`
Source  : 9600ae5
Branch  : md-outputs
Author  : GitHub Actions <actions@github.com>
Time    : 2025-04-01 09:48:31 +0000
Message : markdown source builds

Auto-generated via `{sandpaper}`
Source  : b743890
Branch  : main
Author  : Steve Crouch <s.crouch@software.ac.uk>
Time    : 2025-04-01 09:47:37 +0000
Message : Merge pull request #447 from knarrff/iso-date_in_example

use iso-formated date in example
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.

2 participants