UpdatedPharoByExample
UpdatedPharoByExample copied to clipboard
SquareBracketAssociates
Environment - Document new tools: Versionner, Kommiter, Configuration browser
We can maybe add some documentation about the new tools like Versionner, Kommiter, Configuration browser etc...
I would just have an enumerated list with a two line paragraph for each. The idea is can we push to get a first version of the book out then we can revisit and enhance
On 13 May 2015, at 10:07, CyrilFerlicot [email protected] wrote:
We can maybe add some documentation about the new tools like Versionner, Kommiter, Configuration browser etc...
— Reply to this email directly or view it on GitHub.
Stéphane Ducasse http://stephane.ducasse.free.fr http://www.synectique.eu / http://www.pharo.org 03 59 35 87 52 Assistant: Julie Jonas 03 59 57 78 50 03 59 35 86 16
S. Ducasse - Inria 40, avenue Halley, Parc Scientifique de la Haute Borne, Bât.A, Park Plaza Villeneuve d'Ascq 59650 France
Maybe we can add a method
ATool class>>#upbe
<toolsDocumentation:'2 lines documentation'>
into each tool we want to have a documentation and do a little script to get an automatic list into the book. With that if we delete a tool or add one the documentation will change with only 1 compilation of the book. What do you think ?
On the one hand, I like this idea (of automatically generating a list of tool descriptions with pragmas).
On the other, I'm not sure how useful it will actually be, to have a few lines of explanations in the book. The book should go into more depth than what's available in casually browsing comments (Stef mentioned starting with a couple of paragraphs at least, and then expanding later on as we have time). So, I'm not sure the investment in scripts/infrastructure will be worth it, in that regard.
