codecs: more docs, a terminology guide, consistency in options. #221
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
warpfork
force-pushed
the
codec-terminology-and-config-consistency
branch
from
33d36a6
to
09ad1b7
Compare
No breaking changes. In fact I think this should be behaviorally identical to before, despite the size of the diff. There are some functions that are explicitly marked as deprecated now, but I am not removing them in this diff. One exception: some struct names did change. However, these have not been included in any tagged release so far, so I believe changing them now is still pretty fair game, and the number of affected people should be slim to none. The main source of changes is pushing towards nomenclature consistency, which is described in the new readme file also included the diff.
warpfork
force-pushed
the
codec-terminology-and-config-consistency
branch
from
09ad1b7
to
6d3da1f
Compare
|
It was also discussed in another forum earlier that perhaps it would be nice if the zero values for these config options would actually be the default for that codec. However, that would conflict with using the same constants to describe things across packages, which seems silly, so I've dropped zero-coincides-with-the-default as a goal. |
mvdan
approved these changes
Aug 12, 2021
|
Since the default options are not the zero value, we might want to add a |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No breaking changes. In fact I think this should be behaviorally identical to before, despite the size of the diff. There are some functions that are explicitly marked as deprecated now, but I am not removing them in this diff.
One exception: some struct names did change. However, these have not been included in any tagged release so far, so I believe changing them now is still pretty fair game, and the number of affected people should be slim to none.
The main source of changes is pushing towards nomenclature consistency, which is described in the new readme file also included the diff.