(The second is only an accepted RFC, not implemented yet for Rust)
Show this thread
Things I want from a documentation tool in 2017: - Uses markdown - Generates links from module paths - Executes code examples as tests - Has mechanisms to share setup code for those examples - Provides fuzzy search Rust has 1, 2, 3, 5. Any langs better that I should know about?
-
-
Thanks. Twitter will use this to make your timeline better. UndoUndo
-
-
-
I think Sphinx offers 2, 3, 4, 5. I'd say it's a shame restructured text is such a burden to author, but the ways in which it demands precision are actually very nice for writing docs, technically.
-
I'd be very interested to see how it handles #4. I don't suppose you have a link? (I'm about to head out to Star Wars)
- 4 more replies
New conversation -
-
-
Examples that aren't run as part of the test suite is a non-starter IMO
Thanks. Twitter will use this to make your timeline better. UndoUndo
-
-
-
Elixir does a few of these. It does 2,3,5 and maybe 1 depending on what you mean exactly. It can do 4, but only in an ad hoc way.
Thanks. Twitter will use this to make your timeline better. UndoUndo
-
-
-
Elixir has 1, 2, 3, 5 also. Worth check it out :) number 4 is maybe the hardest thing to have.
Thanks. Twitter will use this to make your timeline better. UndoUndo
-
-
-
We are currently planning how to do custom test runners in Rust. And now I’m wondering if doc tests should be covered by this (and if so, how)
Thanks. Twitter will use this to make your timeline better. UndoUndo
-
-
-
i really like the way golang does the comments, docs and examples. i _think_ that covers 2,3,4 and 5?
Thanks. Twitter will use this to make your timeline better. UndoUndo
-
-
-
For #4, heard
@samselikoff and@ryantotweets talk about using test scenarios of an ember addon as the starting place for live documentation. I imagine it would look something like ember-power-select and ember-basic-dropdown docs (by@MiguelCamba) -
Yep, the project is still WIP but lots of pieces there: https://ember-learn.github.io/ember-cli-addon-docs/ … Here's the DocsDemo components which makes the executable examples easy to write: https://ember-learn.github.io/ember-cli-addon-docs/docs/components/docs-demo …
End of conversation
New conversation -
Loading seems to be taking a while.
Twitter may be over capacity or experiencing a momentary hiccup. Try again or visit Twitter Status for more information.