Opened 10 years ago
Closed 10 years ago
#12991 closed enhancement (fixed)
Don't doctest autogenerated rst files
Reported by: | jhpalmieri | Owned by: | mvngu |
---|---|---|---|
Priority: | minor | Milestone: | sage-5.1 |
Component: | doctest coverage | Keywords: | |
Cc: | Merged in: | sage-5.1.beta2 | |
Authors: | John Palmieri | Reviewers: | Keshav Kini |
Report Upstream: | N/A | Work issues: | |
Branch: | Commit: | ||
Dependencies: | Stopgaps: |
Description (last modified by )
When we build the Sage documentation, we create lots of files which look like the following (SAGE_ROOT/devel/sage/doc/en/reference/sage/algebras/free_algebra_quotient_element.rst
):
.. _sage.algebras.free_algebra_quotient_element: Free algebra quotient elements ============================== .. This file has been autogenerated. .. automodule:: sage.algebras.free_algebra_quotient_element :members: :undoc-members: :show-inheritance:
When we run make ptestlong
, these files get doctested. I don't think there is a good reason for this: we should skip these files when doctesting. There are two ways of doing this: patch the doctesting scripts to skip files containing \n.. This file has been autogenerated.\n
, or write .. nodoctest
as the first line of each of these files. The attached patch does the second of these (a patch to do the first is given in a comment below).
Attachments (1)
Change History (5)
Changed 10 years ago by
comment:1 Changed 10 years ago by
- Description modified (diff)
comment:2 Changed 10 years ago by
- Status changed from new to needs_review
comment:3 Changed 10 years ago by
- Reviewers set to Keshav Kini
- Status changed from needs_review to positive_review
The approach of your patch (rather than your comment) seems to me to be the correct one. It also passes tests on 5.0.beta1, and the code looks reasonable, so positive review from me.
comment:4 Changed 10 years ago by
- Merged in set to sage-5.1.beta2
- Resolution set to fixed
- Status changed from positive_review to closed
For the first approach, apply a patch like this to
SAGE_ROOT/local/bin
:sage-ptest