Skip to content

Fix write example for recordingYear where wrong parameter is used in ID3FrameWithIntegerContent - #115

Merged
chicio merged 1 commit into
chicio:mainfrom
Anrufliste:minor_doc_fix
Jan 17, 2026
Merged

Fix write example for recordingYear where wrong parameter is used in ID3FrameWithIntegerContent#115
chicio merged 1 commit into
chicio:mainfrom
Anrufliste:minor_doc_fix

Conversation

@Anrufliste

Copy link
Copy Markdown
Contributor

ID3FrameWithIntegerContent has wrong parameter name, from context year is used, but the method only accepts value.

Description

In the example the parameter year is replaced by value. I assume year was wrongly taken because of ID3Tag context, but the helper method does know that context and is used in general for.

Motivation and Context

It helps to keep the documentation correct and if some one just copy and pastes the example code is will compile.

How Has This Been Tested?

It's just a fix for the documentation and I used the code within a project. That's how I found that mismatch.

Types of changes

  • Bug fix 🐛 (non-breaking change which fixes an issue)
  • New feature ✨ (non-breaking change which adds functionality)
  • Breaking change 💥 (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project 🍻.
  • My change requires a change to the documentation 💡 and I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document 👥.
  • I have added tests to cover my changes 🎉.
  • All new and existing tests passed ✅.

…r is used, but the method only accepts value.

@chicio chicio left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Hi @Anrufliste , thank you so much for the contribution 🙏

Yes, you're right. The documentation for the recording year frame is wrong as you mentioned in #116.

Merging now. I will add you to the contributors.

Please star this repository to support my work 🙏

@chicio
chicio merged commit d16e1cb into chicio:main Jan 17, 2026
4 of 5 checks passed
@chicio chicio assigned chicio and Anrufliste and unassigned chicio Jan 17, 2026
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