rustdoc book says there is no default favicon

[lolbinarycat]

Location

https://doc.rust-lang.org/nightly/rustdoc/write-documentation/the-doc-attribute.html#html_favicon_url

Summary

If you don't use this attribute, there will be no favicon.

This line is simply no longer true. Rustdoc provides a default favicon now.

[lolbinarycat]

Note that the next section that uses similar wording is correct.

If you don't use this attribute, there will be no logo.

This part is true.

Clarification: the default for favicons is a default image. the default for the logo (the big one on the top of the sidebar) is no image.

[eeshvardasikcm]

I am interested in open discussion opportunity that does not require studying in depth the repository documentation, and discussion that welcomes people of all skill levels. I saw the E-easy label so I thought this would be a good place to start.

So, it looks like a technical way to explain whether or not a favicon will appear based on how the favicon is implemented. Like if you don't do it exactly correct, then it won't show up.

Are you looking for confirmation on your assessment? I can find time later to look at the favicon wording.

[lolbinarycat]

I don't think this is very technical. if you want to confirm what i say is true, just look at the docs for any crate that doesn't use this this attribute. it will use the rust logo as a favicon.

as for what the documentation should say, something like this would work:

If you don't use this attribute, a default favicon will be used.

I don't entirely understand what the second part of your comment is saying, I don't think there is anything to discuss, I am very confident in my assessment of the code, this is all but certainly a simple case of outdated docs.

All that needs to be done is to rewrite that line, and I labeled this as E-easy because it seems like a good opportunity for anyone who wants to familiarize themselves with the contribution process before contributing actually code changes.

Irrelevant Technical Details

We do use a rel alternate secondary favicon, with a different resolution I believe, but that's an implementation detail we have no reason to mention in the docs