2016-07-28 16:18 GMT+02:00 stepharo <stepharo@free.fr>:
I will!
I love to read nice comments
Stef
I updated the slice and added some more example (much more is needed but I think it is better than having no doc :) ). I changed some help topics on refactoring support in nautilus to directly used the refactoring classes comments (no need to maintain two docs), but this is not applicable for all refactorings, for example "generate superclass" and "insert superclass" needs its own description, as there is only one RBAddClassRefactoring comment. please help with reviewing, I am not good at writing this kind of text. The refactoring engine is a great and powerfull piece of code and it would be great to have a proper documentation "in-image". I have seen some bugs, bad code or wrong bug fixes by contributors not fully understanding the framework (me too :) ). just load the slice and open HelpBrowser openOn: RefactoringHelp. thanks nicolai
Le 28/7/16 à 00:38, Nicolai Hess a écrit :
Hi,
I recently added some class comments to the Refactoring-Package. (RBBrowserEnvironments, RBRefactoring, RBNamespace).
Now I added some more HelpTopics describing the refactoring framework, some background information, RBPatternParser and Metavariables, some examples and put the existing class comments into the HelpBook.
see fogbugz issue 18829 <https://pharo.fogbugz.com/f/cases/18829/Add-a-RefactoringFramework-System-He...> Add a RefactoringFramework System HelpTopic you can load the slice and open the HelpBook with
HelpBrowser openOn: RefactoringHelp.
Would be nice if someone can help with proofreading and of course, amy feedback is welcome.
nicolai