Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: descritpion.md are now optional #417

Merged
merged 11 commits into from
Jun 19, 2024
Merged

Conversation

ThibaultFy
Copy link
Member

@ThibaultFy ThibaultFy commented Jun 19, 2024

Related issue

closes FL-1513

Summary

Create an "empty" description file if none given:

image

Notes

Please check if the PR fulfills these requirements

  • If necessary, the changelog has been updated
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • The commit message follows the conventional commit specification
  • For any breaking changes, companion PRs have been opened on the following repositories:

Signed-off-by: ThibaultFy <thibault.fouqueray@gmail.com>
Signed-off-by: ThibaultFy <thibault.fouqueray@gmail.com>
Signed-off-by: ThibaultFy <thibault.fouqueray@gmail.com>
Signed-off-by: ThibaultFy <thibault.fouqueray@gmail.com>
Signed-off-by: ThibaultFy <thibault.fouqueray@gmail.com>
Signed-off-by: ThibaultFy <thibault.fouqueray@gmail.com>
Signed-off-by: ThibaultFy <thibault.fouqueray@gmail.com>
Copy link

linear bot commented Jun 19, 2024

Signed-off-by: ThibaultFy <thibault.fouqueray@gmail.com>
Signed-off-by: ThibaultFy <thibault.fouqueray@gmail.com>
Signed-off-by: ThibaultFy <thibault.fouqueray@gmail.com>
@ThibaultFy ThibaultFy marked this pull request as ready for review June 19, 2024 09:50
@ThibaultFy ThibaultFy requested a review from a team as a code owner June 19, 2024 09:50
Comment on lines 47 to 49
opener_path = tmpdir / "fake_opener.py"
with open(opener_path, "w") as f:
f.write("print('I'm opening your data')")
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure whether we can mock this or not but it is usually considered as a good practice to limit fs interactions in unit tests

Copy link
Member Author

Choose a reason for hiding this comment

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

Even in the pytest tmpdir ? But your right, I don't need to write the file, just to pass the path, good catch :)

substra/sdk/schemas.py Show resolved Hide resolved
Signed-off-by: ThibaultFy <thibault.fouqueray@gmail.com>
@ThibaultFy ThibaultFy merged commit dd01b9b into main Jun 19, 2024
5 checks passed
@ThibaultFy ThibaultFy deleted the chore/optional-description branch June 19, 2024 13:22
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.

3 participants