#15392: Implement minimal model algorithm
--------------------------------------+----------------------------
Reporter: bhutz | Owner: bhutz
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-5.13
Component: algebraic geometry | Resolution:
Keywords: sage-days55 | Merged in:
Authors: bhutz | Reviewers:
Report Upstream: N/A | Work issues:
Branch: | Commit:
Dependencies: | Stopgaps:
--------------------------------------+----------------------------
Comment (by vdelecroix):
Hello,
It is very good that the code is documented and contains references! But
there are several problem with the documentation (see
[[http://sagemath.github.io/git-developer-guide/coding_basics.html
#documentation-strings|sage developer guide]]).
1) there are trailing whitespaces
2) the indentation is not good. The blocks INPUT, EXAMPLES must have the
same identation as the documentation and you must have a blankline between
the block name EXAMPLES and its content (for example lines 201-202 are
wrong).
{{{
def my_function(arg1, arg2):
"""
This is a nice function
INPUT:
- ``arg1`` - a first nice argument
- ``arg2`` - an other nice argument
EXAMPLES::
sage: my_function(8,3)
We can also use the function with strings::
sage: my_function('toto', 'bibi')
"""
}}}
3) Bibliography is not set up properly
4) In the examples (at least) respect the convention "my_variable = f()"
and do not use "my_variable=f()". If possible, try to be coherent in
function arguments and prefer "def f(a, b=3, c=4)" to "def f(a,b = 3,
c=4)".
5) For the name I guess "is_affine_minimal" is more suited than
"affine_minimal".
--
Ticket URL: <http://trac.sagemath.org/ticket/15392#comment:4>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/groups/opt_out.
