Comments (7)
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.
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.
It is your call @jwarwick :)
from ex_doc.
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.
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.
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.
@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)
- Bullet list not displayed correctly HOT 4
- Better integrate Erlang/Elixir
- Mobile: Search bar is too sensitive to page scroll HOT 2
- Warn about docs for out-of-date versions HOT 1
- Odd Gradient with mobile breakpoint in light mode HOT 1
- feature request: Link to Anchor callback/function auto-links like with Modules and Extra pages
- Possible error when deprecating binaries path for assets HOT 4
- Failure to render links for specs when using Elixir 1.17 or later HOT 1
- No support for debug_info keys? HOT 1
- Search page shows no results even though autocomplete finds them HOT 1
- Signs in integer literals trigger warning HOT 3
- More explicit warning when type not visible because module is not visible HOT 2
- Fail to generate docs due to earmark_parser_string_lexer not available HOT 2
- Remove support for application/erlang+html HOT 4
- Screen reader text obscures search HOT 10
- No information on how to run locally HOT 2
- Admonition blockquotes should be converted to divs HOT 1
- Sidebar missing until mermaidjs finishes loading HOT 4
- Selectable/copyable text includes evaluation output HOT 4
- Incorrect line-height of a code block in a header HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ex_doc.