GithubHelp home page GithubHelp logo

Comments (7)

josevalim avatar josevalim commented on June 1, 2024

Hey @alexrp, that's a very good point.

For Elixir, I would be more inclined to go with the second option. I think listing all modules by full name would increase the size of the list and probably hurt discoverability because you would get too much noise.

On the other hand, for other projects (that are not Elixir), the nesting will probably be unnecessary since you would likely have just one root module.

That said, maybe we should go with 1) because it would at least be consistent across the board.

/cc @rafaelfranca

from ex_doc.

jwarwick avatar jwarwick commented on June 1, 2024

Anyone have further thoughts on this issue? I made a feature branch that lists the whole module name (without nesting) to see what it would look like: jwarwick/ex_doc@87b6e1f

For the Elixir source, it looks okay. The Mix.Tasks.* list gets a bit long though.

from ex_doc.

josevalim avatar josevalim commented on June 1, 2024

It is your call @jwarwick :)

from ex_doc.

jwarwick avatar jwarwick commented on June 1, 2024

Ha! Not sure I'm up for this level of pressure 😰

I'll stare at a bit more, maybe try indenting the children and see if that helps with the noise.

from ex_doc.

josevalim avatar josevalim commented on June 1, 2024

Hahaha, don't worry @jwarwick! we can always experiment with some approaches too and then rollback if we are not comfortable with it. Just to have something to compare, I have pushed elixir docs using your changes to the master docs, so people can compare the two versions directly:

http://elixir-lang.org/docs/master/ (new)
http://elixir-lang.org/docs/stable/ (old)

I will send an e-mail to the mailing list too and get some feedback!

from ex_doc.

josevalim avatar josevalim commented on June 1, 2024

And for what is worthy, I prefer the new format, much easier to discover and see which modules are available. There is some noise but it is easy to scroll through it. 😄

from ex_doc.

josevalim avatar josevalim commented on June 1, 2024

@jwarwick I think we should go ahead and merge your changes. Would you please send a pull request or merge into master? :)

from ex_doc.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.