Submitting a module to Sage trac with supporting test code and documentation

asked 2012-06-20 01:38:05 +0200

araichev
184 ●10 ●19 ●25

Hi all:

I recently wrote

a new Python module for Sage
a Python module that tests (1) using the unittest module
a PDF document describing the mathematical background for the algorithms in (1)

I want to submit all three of these to the Sage trac server for reviewers to refer to. Is that a good idea? If so, what's the best way to do that? I know how to submit (1) as a patch, but what about (2) and (3)?

Thanks.

Comments

The test module could also be submitted as a patch and invoked as part of the Sage doctests of the main module. If appropriate, the document describing the algorithms could be upload to the arXiv for posterity.

benjaminfjones ( 2012-06-20 13:38:18 +0200 )edit

add a comment

answered 2012-06-20 12:20:21 +0200

kcrisman
12222 ●41 ●135 ●254

I don't think we would want random pdf documents included in Sage. Sage supports fairly arbitrary LaTeX using jsmath (soon to be MathJax), so if you really needed to include it (as opposed to link to an article), you could do so in the documentation, especially at the top of the file.

You also don't need to include a separate testing module using unittest; instead, just use the usual Sage doctest framework to include lots of examples (see pretty much any file for examples, or the Sage developer guide section on coding conventions in Sage. If you really needed to, you could even include a separate testing module using those same conventions.

edit flag offensive delete link

Comments

Thanks. OK, i'll put the PDF on arXiv and reference it in the module. Regarding the separate unittest test module, i already wrote it and found it more convenient to write and use than putting the tests in the main module's docstrings. So, if it's OK to still use it, do i just submit it as a separate patch?

araichev ( 2012-06-20 19:40:46 +0200 )edit

You can put in a test module, but it will probably get 'needs work' if it's not in the Sage standard format for tests. But that is a discussion that can happen at the ticket - go ahead and open a ticket and post a patch!

kcrisman ( 2012-06-21 12:12:20 +0200 )edit

add a comment

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Submitting a module to Sage trac with supporting test code and documentation

Comments

1 Answer

Comments

Your Answer

Question Tools

Stats

Related questions

Submitting a module to Sage trac with supporting test code and documentation edit

Comments

1 Answer

Comments

Your Answer

Question Tools

Stats

Related questions

Submitting a module to Sage trac with supporting test code and documentation