Supported File Types Section Produces Invalid List of FileType References for Tag Formats in Documentation

[Lepidopteran]

Reproducer

Look at the "Supported file types" section for any tag format.

Some examples include:

• ApeTag
• Id3v2Tag
• Id3v1Tag
• VorbisComments

Summary

I was looking at the documentation for various tags and I've found every tag format, the Supported file types section produces invalid references to the various file types

I'm guessing it's because of Line 19 to 24 in lofty_tag.rs in the lofty_attr crate:

fn emit_doc_comment(&self) -> String {
	match self {
		SupportedFormat::Full(path) => format!(
			"* [`FileType::{ft}`](crate::FileType::{ft})\n",
			ft = path.get_ident().unwrap()
		),
		SupportedFormat::ReadOnly(path) => format!(
			"* [`FileType::{ft}`](crate::FileType::{ft}) **(READ ONLY)**\n",
			ft = path.get_ident().unwrap()
		),
	}
}

It's generating documentation that points to crate::FileType::<File_Format> which is invalid because, file types are now stored crate::file::FileType::<File_Format>.

I did try to change it myself, but when I tested it locally, it did not produce a different documentation result for me.

I'm not sure why I couldn't get it to work, but I wanted to point this out!

Expected behavior

In the Supported file types section, produce a list that points to crate::file::FileType::<File_Format> instead of crate::FileType::<File_Format>

Side Note

This is a amazing project!

I was previously using id3, metaflac and mp4ameta for a personal project of mine and I wanted to support reading and writing to more tag formats other than id3, Itunes, and a partial of vorbiscomments, and I was daunting the task of writing my own readers and writers.

So when finding your project, I was relieved, and after trying your project out, I'd say you have the best (and to my knowledge only) library that provides a nice API for every popular metadata standard out there!

So to end all, thank you!

Assets

No response

[Serial-ATA]

I'm guessing it's because of Line 19 to 24 in lofty_tag.rs in the lofty_attr crate

Yep, that's what generates them. I imagine it wasn't being updated since the lofty crate just depends on the published versions of the workspace crates:

lofty-rs/lofty/Cargo.toml

Lines 20 to 21 in 3367067

	# Proc macros
	lofty_attr = "0.11.0"

It really should use path dependencies, I just didn't think to do that when I migrated the repo to a workspace.

If you already made the changes locally, feel free to make a PR. It may be a bit before I can get to it myself.

And thank you for the kind words and doc fixes you've been making! ❤️

[Lepidopteran]

Oh I see, I can definitely make a PR request!

Would you recommend I only change the lofty_atrr to path based on my local or should I commit that in the PR as well?

And you're welcome, you're great to work with!

[Serial-ATA]

You can change it to a path in a PR, just do: lofty_attr = { path = "../lofty_attr" }

[Lepidopteran]

It looks like the documentation has not updated. Do you have to push out a new version to update said documentation?

[Serial-ATA]

Yep, I can release 0.22.2 tomorrow if I have time. If I don't get around to it though, you can always cargo doc --open -p lofty.