cleanup

[MareoRaft]

There are a number of last-minute "cleanup" things to do before adding code to sage itself. So I don't forget, I maintain a list here:

done

• prefaces for examples go INSIDE the EXAMPLES blocks. --> done
• remove commented out code --> done
• follow PEP 8 (use autopep8) --> done
• follow PEP 257 (see https://www.python.org/dev/peps/pep-0257/) --> done
• maximum line-length of 80 characters --> done
• EVERY function must have a docstring, even the protected, private ones, with exception of init (https://doc.sagemath.org/html/en/developer/coding_basics.html#the-docstring-of-a-function-content) --> done
• class names in docstrings need :class: roles --> done
• use algorithm instead of method when there is a choice of how to calculate (https://doc.sagemath.org/html/en/developer/coding_basics.html#miscellanous-minor-things) --> done
• use check to decide whether or not to verify input parameters --> done
• a SEEALSO block is recommended --> done
  • references go in master bib file --> done. may need some formatting

almost done

• move most tests into TESTS blocks, # long time for long time tests --> NOT FINISHED
• remove useless comments --> all done except strong_marked_tableau.py
• EVERY function must have at least one example (in EXAMPLES block) --> all except george's smt funcs, and all.py is finished up to dual_k_catalan_function. stuff after that won't be migrated now anyway

can't do it

• use UniqueRepresentation where sensible --> can't get this to work

during migrate

• in SAGE_ROOT/src/sage/all.py add lines like from sage.measure_theory.all import * for your stuff. (see also https://doc.sagemath.org/html/en/developer/coding_basics.html) --> wait on migrate
• function parameters in double backticks in docstrings --> wait on "this" terminology for classes.
• put functions / class methods in a reasonable order, with dunderscore methods before others --> wait on migrate to official sage repo
• put the proper heading at top of each file (https://doc.sagemath.org/html/en/developer/coding_basics.html#headings-of-sage-library-code-files) --> wait on migrate
• other sage documentation (such as hl_creation_operator, finite dimensional free algebra, other free algebra) should get a SEEALSO that points to my functions

last of migrate

• 80 char docstring length limit

after migrate

• changing k_combinat_for_sage itself to use new syntax. That will be after opening the migration tickets.

[MareoRaft]

branch migration

Now using migration branch for this. Which will probably be merged with master frequently.

[MareoRaft]

how many tests to move over, omit the newest untested functions

[MareoRaft]

START MIGRATING

[MareoRaft]

ask about "this" terminology for classes in ticket. also note about UniqueRepresentation where sensible in ticket.

[MareoRaft]

Partition.py migrated, waiting on review. We can now create a skew_partition branch off the partition branch, a k_shape branch off the skew_partition branch, and so forth.

We can work on those branches even though we are waiting on partition. Then merge in changes as necessary.