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

Release 1.3.0 #455

Merged
merged 6 commits into from
Jul 18, 2024
Merged

Release 1.3.0 #455

merged 6 commits into from
Jul 18, 2024

Conversation

hagenw
Copy link
Member

@hagenw hagenw commented Jul 15, 2024

image

@hagenw hagenw marked this pull request as draft July 15, 2024 10:27
@hagenw hagenw marked this pull request as ready for review July 17, 2024 08:22
@hagenw
Copy link
Member Author

hagenw commented Jul 17, 2024

This is a breaking change release as code that expects a table to be stored as a csv file will break. But as around 99% of use cases will not directly try to access the csv files, but use audb and audformat to access tables, I think it should be fine to go with version 1.3.0 instead of 2.0.0.

--------------------------

* Added: ``strict`` argument
to ``audformat.utils.hash()``.
Copy link
Member

Choose a reason for hiding this comment

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

This has a full stop at the end of the sentence. The others do not. What is convention that we are using here?

Copy link
Member Author

Choose a reason for hiding this comment

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

The convention is to not use a full stop at the last sentence in an entry. But for earlier ones we use a full stops:

* Added: ``strict`` argument
  to ``audformat.utils.hash()``.
  If set to ``True``,
  the order of the data,
  and its level/column names
  are taken into account
  when calculating the hash

As you can see the last hash has no full stop.

Copy link
Member

@ChristianGeng ChristianGeng left a comment

Choose a reason for hiding this comment

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

This looks good to me content-wise.

I have one question about interpuntuation, but that is not a blocker for giving approval.

@hagenw hagenw merged commit 5a8f650 into main Jul 18, 2024
10 checks passed
@hagenw hagenw deleted the release-1.3.0 branch July 18, 2024 07:43
@ChristianGeng
Copy link
Member

This is a breaking change release as code that expects a table to be stored as a csv file will break. But as around 99% of use cases will not directly try to access the csv files, but use audb and audformat to access tables, I think it should be fine to go with version 1.3.0 instead of 2.0.0.

audformat.Database.save and audformat.Table.save are part of the public API and documented. But the gross usage pattern stays intact. So going without a major release is fine.

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