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)
- Add a title attribute to sidebar links HOT 13
- Search is not working for some terms HOT 1
- Sidebar overflow is not showing a scrollbar on my browsers HOT 1
- SVG logo is not shown HOT 3
- Getting an invalid epub format
- EPUB: Links to anchors like #&&/2 cause a fatal error while parsing the file
- Autolink private dependencies HOT 1
- UX issues related to search bar location HOT 6
- Linebreaks in the middle of `++` HOT 8
- Head of document missing when printing HOT 3
- Equivalent for edocs's {sort_functions, false} HOT 5
- Admonitions not styled properly within cheat sheets HOT 7
- Text of code block within a info admonition block is barely legible in darkmode HOT 5
- Allow adding *.exs files to the docs HOT 2
- Introduce meta tags to customize search HOT 1
- Search thinks there are ids for <h4> HOT 3
- Building docs when module compiled using `+deterministic` fails HOT 4
- Ability to configure skipping of types and specs in doc generation HOT 10
- Question concerning usage of EarmarkParser HOT 4
- Version dropdown doesn't work in v0.32.0 HOT 1
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.