Le 16/9/16 à 00:19, p...@highoctane.be a écrit :
I'd be more interested with a package level doc than a class doc or test.
It is at another level and it will come.
The manisfest is here and we should update Nautilus to show other information.

Now I'm curious to see how many people will use that when I see the level of description in configuration of.

Package level doc is quite useful to outline how some things are working together, something which is quite hard to figure out except by reading external doc or inferring things by walking through the code or a running test.

I'm the guy that propose SmallUML to embed description of UML diagram as package level 5 years ago and before that I tried
to add png of diagram so I'm convinced about that.

Having the ability to read about a package would be very useful. Basically, this is what Java provides.



On Thu, Sep 15, 2016 at 8:45 PM, stepharo <steph...@free.fr <mailto:steph...@free.fr>> wrote:

    Hi all

    I want something similar in the spirit to PythonDocTest

    I'm talking about

        "Returns the base of the basename,
            /foo/gloops.taz basename is 'gloops.taz'
            / basename is '/'"

    Pragmas do not work well i.e.,
        "Returns the base of the basename"
         <expr: '''/foo/gloops.taz'' asFileReference basename' result:

    We should invent a syntax to be put inside comments and that we
    can easily parse because we need to improve
    the use and discovery of the library.

    I was thinking about

        "Returns the base of the basename"
        '/foo/gloops.taz' asFileReference basename
        >>> 'gloops.taz'

    Do you have any idea?

    I cannot not do anything and just complain that our methods are
    not that well documented.
    We as a community should take this and build an super cool system.

    I tried and defined >>> on Object to see if it works!

    Object >>> aResultingObject
        "If the method comment contains >>> then it is a pharo
    documentated test. We can check that it is true."

        '/foo/gloops.taz' asFileReference basename
       >>> 'gloops.taz'

        ^ self = aResultingObject


Reply via email to