[sage-devel] Documenting Factory Functions (RE trac #13282)

[samgonshaw]

Say I wrote a suite of functions and made them available through a factory 
class such as:

{{{
class MyFunctions():
    def FunctionA(self,*args,**kwargs):
        ...
    def Functionb(self,*args,**kwargs):
        ...
    def FunctionC(self,*args,**kwargs):
        ...

my_functions=MyFunctions()
}}}

and importing my_functions on opening sage.
When writing documentation for FunctionA,B,C,... for examples and tests 
should I begin these for each function with a new instance of the class, or 
should I use the standard instance that the user will access?

i.e.
{{{
sage: inst=MyFunctions()
sage: inst.FunctionA(*args,**kwargs)
}}}

or plain ``sage: my_functions.FunctionA(*args,**kwargs)``

This is for the work on 
#13282<http://trac.sagemath.org/sage_trac/ticket/13282>, 
providing a suite of functions to access the graded ring databases of Fano 
polytopes.

Thanks,

Samuel Gonshaw

-- 
-- 
To post to this group, send an email to sage-devel@googlegroups.com
To unsubscribe from this group, send an email to 
sage-devel+unsubscr...@googlegroups.com
For more options, visit this group at http://groups.google.com/group/sage-devel
URL: http://www.sagemath.org