Separate tasks from regular modules #713
Conversation
|
Here's how it looks in phoenix right now:
The URL of the page is exactly the same - with the full module name. I don't think it's worth it to change it considering we would break all the bookmarks and links doing so. |
| end | ||
| # assert Templates.synopsis(doc2) == | ||
| # "Example function: Summary should not display trailing puntuation" | ||
| # end |
There was a problem hiding this comment.
Moving the synopsis generation to the retriever means we can't test it as easily now.
I'm not 100% sure about this move. Maybe it's fine to use the first line of the moduledoc for tasks as well instead of the shortdoc. It's only used on the "API Reference" page, which is, in my experience, used rather rarely.
There was a problem hiding this comment.
Yes, let's revert the synopsis change for now. We can always add the feature if necessary later.
|
I would use "Mix task" as the label on the right of the name instead of "task" to be clearer. |
|
@whatyouhide tasks is fine as you can get the context as soon as you click on the first one of them. My only suggestion is to change the title on the right side to be |
|
Should we also change the name in the summary on the left? |
|
I updated it (not pushed yet) to list
|
|
@michalmuskala let's keep mix in bold as well, basically as part of the title. Is that possible? |
|
Anything's possible if you try hard enough 😏 I'll change it. |
|
@josevalim It would look like this:
Or do we want to keep the small "task" there as well? |
|
Another question is the page title - should it also include |
Up to you. It doesn't feel it is necessary though.
Up to you. It doesn't feel it is necessary though. |
|
Let us know when this is ready to ship so we can release a new version. :) |
michalmuskala
force-pushed
the
tasks
branch
2 times, most recently
from
70c3428
to
6c37363
Compare
![sourcelevel-bot[bot]](https://avatars.githubusercontent.com/in/597?s=60&v=4){kind=small}
assets/test/search.spec.js
Outdated
| functions: [ | ||
| {id: 'hello world', anchor: 'hello-world'} | ||
| ] | ||
| }, { | ||
| id: 'world2', | ||
| id: 'world2', title: 'world2', |
There was a problem hiding this comment.
Object properties must go on a new line if they aren't all on the same line.
assets/test/search.spec.js
Outdated
| functions: [ | ||
| {id: 'hello world', anchor: 'hello-world'} | ||
| ] | ||
| }, { | ||
| id: 'world', | ||
| id: 'id2', title: 'world', |
There was a problem hiding this comment.
Object properties must go on a new line if they aren't all on the same line.
assets/test/search.spec.js
Outdated
| @@ -12,30 +13,30 @@ describe('search', () => { | |||
|
|
|||
| it('searches for function matches', () => { | |||
| var nodes = [{ | |||
| id: 'hello world', | |||
| id: 'id1', title: 'hello world', | |||
There was a problem hiding this comment.
Object properties must go on a new line if they aren't all on the same line.
michalmuskala
changed the title
|
This is ready for review |
|
❤️ 💚 💙 💛 💜 |
|
\cc @Kapeli, heyo, I think this will affect how documentation is structured in Dash: there's now a new "Mix Tasks" section alongside Protocols, Exceptions, and so on. May be worth mirroring that in Dash.app :) |
|
Thanks @whatyouhide, I'll make sure Dash works well with this change. |
Mix.Tasks.Foo.Bartofoo.barCloses #712