SeaGriff / Graph-Orientations-and-Divisors

MIT License
7 stars 1 forks source link

contribute this to SageMath? #1

Open dimpase opened 2 years ago

dimpase commented 2 years ago

just a suggestion - would be nice to have in the library.

SeaGriff commented 2 years ago

I would be interested in doing that - but I don't really know how to go about it

dimpase commented 1 year ago

cf https://github.com/SeaGriff/Graph-Orientations-and-Divisors/issues/3#issuecomment-1316565141

dimpase commented 1 year ago

In particular, this

$ ../sage/sage -t newmethods.py 
Running doctests with ID 2022-11-16-09-34-31-0c515e43.
Git branch: u/dimpase/make_hadamard_matrix_use_all_available_methods
Git ref: 9.7.beta6-2959-g4af045a9cc-dirty
Running with SAGE_LOCAL='/home/dimpase/work/software/sage/local' and SAGE_VENV='/home/dimpase/work/software/sage/local/var/lib/sage/venv-python3.9'
Using --optional=debian,fricas,gap_packages,libsemigroups,onetbb,papilo,pip,sage,sage_spkg
Features to be detected: 4ti2,benzene,bliss,buckygen,conway_polynomials,csdp,database_cremona_ellcurve,database_cremona_mini_ellcurve,database_cubic_hecke,database_jones_numfield,database_knotinfo,dvipng,gfan,graphviz,imagemagick,jupymake,kenzo,latte_int,lrslib,mcqd,meataxe,msolve,nauty,palp,pandoc,pdf2svg,pdftocairo,phitigra,plantri,polytopes_db,polytopes_db_4d,pynormaliz,python_igraph,rubiks,sage.combinat,sage.geometry.polyhedron,sage.graphs,sage.groups,sage.misc.cython,sage.plot,sage.rings.number_field,sage.rings.padics,sage.rings.real_double,sage.symbolic,sage_numerical_backends_coin,sagemath_doc_html,sphinx,tdlib
Doctesting 1 file.
sage -t --warn-long 109.3 --random-seed=150278935159034824862547852874193619842 newmethods.py
    [0 tests, 0.01 s]
----------------------------------------------------------------------
All tests passed!
----------------------------------------------------------------------
Total time for all tests: 0.1 seconds
    cpu time: 0.0 seconds
    cumulative wall time: 0.0 seconds
Features detected for doctesting: 

"works" - there are no docstrings to test though.

However, sage -t CycleCocycleSystem.py fails with obscure import error related to newmethods.

dimpase commented 1 year ago

4 will take care of sage -t CycleCocycleSystem.py failing with an import error. So the task is to actually write docstrings. Note that they are also used to generate documentation, so they ought to be detailed - at least for functions which

are really meant to be used by users.

Docstrings are in yet another markdown flavour (arrgh...), called markup, aka reST.

Watch out for correct number of spaces, etc...