-
-
Notifications
You must be signed in to change notification settings - Fork 64
Better document existing utility methods #357
Copy link
Copy link
Open
Labels
docsRelated to documentationRelated to documentationgood first issueThese issues are a good way to get started with LoftyThese issues are a good way to get started with Loftyhelp wantedExtra attention is neededExtra attention is needed
Metadata
Metadata
Assignees
Labels
docsRelated to documentationRelated to documentationgood first issueThese issues are a good way to get started with LoftyThese issues are a good way to get started with Loftyhelp wantedExtra attention is neededExtra attention is needed
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:
Tag::take_strings,Tag::get_strings}take_stringsinstead of repeatedly cloning, since most don't write tags back to files.TagItems and check theItemValue.get_stringsexists for that purpose.ItemKey. That makes it appear as though Lofty is only capable of providing the items accessible throughAccessor. (!!!)Tag::get_picture_typeI 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.