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

Better document existing utility methods #357

Open
Serial-ATA opened this issue Mar 12, 2024 · 0 comments
Open

Better document existing utility methods #357

Serial-ATA opened this issue Mar 12, 2024 · 0 comments
Labels
docs Related to documentation good first issue These issues are a good way to get started with Lofty help wanted Extra attention is needed

Comments

@Serial-ATA
Copy link
Owner

Having looked through multiple projects over the years, it's clear that Lofty's API either isn't the best documented or the easiest to understand. Some patterns keep showing up, namely:

  • Not using {Tag::take_strings, Tag::get_strings}
    • Many projects could use take_strings instead of repeatedly cloning, since most don't write tags back to files.
    • Additionally, many projects could benefit from not having to iterate TagItems and check the ItemValue. get_strings exists for that purpose.
    • Finally, I have seen some projects that don't know about ItemKey. That makes it appear as though Lofty is only capable of providing the items accessible through Accessor. (!!!)
  • Not using Tag::get_picture_type
    • Many will iterate all pictures to find the one they want. That isn't necessary.

I consider this an issue with the docs, not with the projects. I believe there are other things I have found in the past, but this is what I could think of for now.

@Serial-ATA Serial-ATA added help wanted Extra attention is needed docs Related to documentation good first issue These issues are a good way to get started with Lofty labels Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Related to documentation good first issue These issues are a good way to get started with Lofty help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant