Skip to content
This repository has been archived by the owner on Jan 30, 2023. It is now read-only.

Commit

Permalink
Still more fine tuning.
Browse files Browse the repository at this point in the history
  • Loading branch information
jm58660 committed Oct 18, 2016
1 parent 24e3ab9 commit c446203
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions src/doc/en/developer/coding_basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1073,8 +1073,7 @@ Global options for classes can be defined in Sage using
Miscellanous minor things
=========================

Some decisions are arbitrary, but common convention makes the program
to look polished and professional.
Some decisions are arbitrary, but common convention make life easier.

* Non-ASCII names in identifiers:

Expand All @@ -1090,32 +1089,32 @@ to look polished and professional.
different keyword with the same meaning (for example, do not use
``method``; use ``algorithm`` instead).

* ``algorithm``, a string or ``None``: Choose between various
* ``algorithm``, a string or ``None``: choose between various
implementation or algorithm. Use ``None`` as a default that
selects a sensible default, which could depend on installed
optional packages.

* ``certificate``, a Boolean with ``False`` as default: Whether the
* ``certificate``, a Boolean with ``False`` as default: whether the
function should return some kind of certificate together with the
result. With ``certificate=True`` the return value should be a
pair `(r, c)` where `r` is the result that would be given with
``certificate=False`` and `c` is the certificate or ``None`` if
there is no meaningfull certificate.

* ``proof``, a Boolean with ``True`` as default: If ``True``,
* ``proof``, a Boolean with ``True`` as default: if ``True``,
require a mathematically proven computation. If ``False``, a
probabilistic algorithm or an algorithm relying to non-proved
hypothesis like RH can be used.

* ``check``, a Boolean: Do some additional checks to verify the
* ``check``, a Boolean: do some additional checks to verify the
input parameters. This should not otherwise influence the
functioning of the code: if code works with ``check=True``, it should
also work with ``check=False``.

* ``coerce``, a Boolean: Convert the input parameters to a suitable
* ``coerce``, a Boolean: convert the input parameters to a suitable
parent. This is typically used in constructors. You can call a
method with ``coerce=False`` to skip some checks if the parent is
known to be correct.

* ``inplace``, a Boolean: Whether to modify the object in-place or
* ``inplace``, a Boolean: whether to modify the object in-place or
to return a copy.

0 comments on commit c446203

Please sign in to comment.