Comments (8)
It's a bit complicated as there's also things like modules which can be used as behaviours, who have a special tag in ex_doc right now. And we're likely to see more of these as Elixir evolves.
I do understand your point though and having the exceptions clutter up the records list isn't ideal.
This discussion is likely to go much broader than exceptions and records fairly quickly, so can we move it to the mailing list?
from ex_doc.
I would honestly move records to the regular group. Leave the other tabs
being Protocols and Exceptions.
from ex_doc.
IMO, it should be Modules, Protocols, Exceptions, Records. Behaviours should be in Modules like it is today. Anything that has a special macro for generating a form of module should have a separate tab. defmodule
, defprotocol
, defexception
, defrecord
.
from ex_doc.
That's going to be a lot of tabs.
from ex_doc.
@pminten One more tab than there is today (Exceptions).
from ex_doc.
The thing is that records are going to be even less important once R17 is out. And I think putting them together with modules makes sense from the user perspective. For example, a HashDict is a record, a Range as well, why you need to search one in one tab and the other in the other?
from ex_doc.
But with HashDict how would you (as user) know that it's really a data type "object" module? Specifically knowing that HashDict can be used with defimpl would be useful.
from ex_doc.
@pminten Ah, that's a good point. So maybe that is the distinction we should make.
from ex_doc.
Related Issues (20)
- No doc generated when @impl Application specified HOT 1
- Codeblocks that contain ? throws a warning HOT 1
- Proposal: Autolink with `[code]` HOT 11
- Showing `:since` metadata for modules HOT 2
- Provide tab support for multiple languages HOT 27
- Very low contrast in sidebar HOT 36
- Text rendering: weight and consistency across OSes HOT 5
- Search HexDocs appears even when a package is not specified HOT 2
- v0.29.3 not in master branch HOT 1
- Load `dist/html-3CAFJ3W7.js` script as deferred? HOT 4
- ** (FunctionClauseError) no function clause matching in ExDoc.Utils.source_url_pattern/3 HOT 3
- No formatting inside of details elements HOT 2
- ExDocs prints errors on case insensitive filesystems in some cases HOT 4
- on-hover anchor's are overlapped by admonition block icons HOT 2
- H3 Heading renders as black for admonition block title
- Proposal: Custom markdown interpolation HOT 28
- Improve named typespec HOT 2
- Compilation warnings from `makeup_html` and `makeup_erlang` HOT 8
- Code within admonition block is hard to read in dark mode HOT 1
- Error generating docs for Elixir 1.15.2 HOT 4
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.