My struggle with docstrings

%run MyTools.ipynb

mydoc(myfun, method='both')

Display the signature of myfun followed by the docstring of myfun. Set method ='signature' or 'method = 'docstring' or 'method = 'both'

my_graph_show(G)

Show a graph Greg’s way. Prints the vertices and edges of the graph G.

add_vertex_monomials(G=Graph on 0 vertices, method='integer', ring=False)

Add monomials to vertices of a graph.

The add_vertex_monomials function takes a graph G, as well as optional parameters method and ring. The function creates a new graph H with vertices labeled by monomials. The monomials are chosen based on the number of vertices in G. If the method parameter is set to ‘alpha’ and the number of vertices in G is less than or equal to 10, the monomials are chosen as alphabetical letters (‘a’ to ‘k’). Otherwise, the monomials are chosen as strings of the form ‘a0’, ‘a1’, …, ‘an-1’, where n is the number of vertices in G. The function then adds the vertices from G to H using the monomials as labels, and adds the edges from G to H using the monomials as endpoints. If the ring parameter is set to True, the function also creates a polynomial ring V with the chosen monomials and ‘invlex’ order, and returns both H and V. Otherwise, it returns only H.

INPUT:

• G – graph object (default: Graph());

• method – integer (default: integer);

OUTPUT: The graph with monomials as vertices

EXAMPLES:

This example illustrates … ::

sage: A = ModuliSpace()
sage: A.point(2,3)
xxx

? add_vertex_monomials

%pdef add_vertex_monomials

 add_vertex_monomials(G=Graph on 0 vertices, method='integer', ring=False)
 

%pdoc add_vertex_monomials

help(add_vertex_monomials)

Help on function add_vertex_monomials in module __main__:

add_vertex_monomials(G=Graph on 0 vertices, method='integer', ring=False)
    Add monomials to vertices of a graph.

    The add_vertex_monomials function takes a graph G, as well as optional parameters method and ring. The function creates a new graph H with vertices labeled by monomials. The monomials are chosen based on the number of vertices in G. If the method parameter is set to 'alpha' and the number of vertices in G is less than or equal to 10, the monomials are chosen as alphabetical letters ('a' to 'k'). Otherwise, the monomials are chosen as strings of the form 'a0', 'a1', ..., 'an-1', where n is the number of vertices in G. The function then adds the vertices from G to H using the monomials as labels, and adds the edges from G to H using the monomials as endpoints. If the ring parameter is set to True, the function also creates a polynomial ring V with the chosen monomials and 'invlex' order, and returns both H and V. Otherwise, it returns only H.

    INPUT:

    - ``G`` -- graph object (default: `Graph()`);

    - ``method`` -- integer (default: ``integer``);

    OUTPUT: The graph with monomials as vertices

    EXAMPLES:

    This example illustrates ... ::

        sage: A = ModuliSpace()
        sage: A.point(2,3)
        xxx