Annotate modules visually when `@moduledoc since: "..."` is present about ex_doc HOT 8 CLOSED

@josevalim mmm I disagree here, because:

I was looking at PartitionSupervisor in Elixir, for example, and had to scroll through functions to know that all the functions were added in Elixir 1.14, which made me realize the whole module was added in Elixir 1.14

I think this is a pretty big DX deal. Considering this feature is visually a really tiny addition, are we sure we want to let it go? 😬

from ex_doc.

We typically don't automatically add sentences. If that's a concern, then Elixir can add it directly to its docs. I would personally wait, there is no reason to rush and churn.

from ex_doc.

I would like implementing this, but I'm not sure how this should look like :/
I did some experimentation locally but couldn't find a way that looks nice

• maybe adding it on the right, but there's no background as opposed to the functions
• maybe adding in a box below, similar to the deprecation message

from ex_doc.

I will go ahead and say no on this one because, we would still need to propagate it, as someone can still be linked directly to the function, so I am not that sure the additional information and clutter is worth it, given we propagate and refer to it on all entries too. :)

from ex_doc.

I think it would be a nice addition and it looks good in this particular case. Here's a mockup:

But it can get really busy:

so yeah not sure.

from ex_doc.

What about something like "This module is available since v..." as the first sentence of the module doc, styled slightly different?

from ex_doc.

Our goal is to move the search bar into the main page and, when we do so, we might move the cog icon, making it more or less cluttered, but I think right now is not the time for this. We can reevaluate in the future.

from ex_doc.

@josevalim maybe we can out a solution for this and then re-evaluate when we do the changes you just mentioned? Like, we go with the sentence at the start of the moduledoc to get the feature and info to users, and then re-evaluate. 🙃

from ex_doc.