>
> For myself only, I tend to put "Examples" upper, and "References" below.
> And "See Also" after the examples. I try to explain it, that I split it
> in my mind as:
>
>    # Text description
>    Short summary
>    Deprecation warning
>    Extended summary
>
>    # Technical information
>    Parameters
>    Returns
>    Other parameters
>    Raises
>
>    # Use cases: look here, to see, try it or to see the other things.
>    Examples
>    See Also
>
>    # Additional text info.
>    # Read it after the above things are read, so it is clear
>    # what are the notes about.
>    # And only if you interested in it.
>    Notes
>
>    # Go away to the library only,
>    # when the above text is not sufficient.
>

This is more to my liking, as well.

-- 
You received this message because you are subscribed to the Google Groups 
"sympy" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/sympy?hl=en.

Reply via email to