#17571: Method tracing fixture
-------------------------------------+-------------------------------------
Reporter: gagern | Owner:
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-6.5
Component: doctest framework | Resolution:
Keywords: | Merged in:
Authors: Martin von Gagern | Reviewers:
Report Upstream: N/A | Work issues:
Branch: | Commit:
u/gagern/ticket/17571 | b89fb603fce4e71a535b5bbf4bc052a70b33999d
Dependencies: | Stopgaps:
-------------------------------------+-------------------------------------
Changes (by gagern):
* status: new => needs_review
* commit: => b89fb603fce4e71a535b5bbf4bc052a70b33999d
Comment:
Replying to [comment:26:ticket:16571 niles]:
> * The function `traceMethod` should be `trace_method` to fit the
standard naming convention. Was there a strong reason for the name you
gave it? If not, please change.
Done.
> * `PropertyAccessTracerProxy.__init__` and
`PropertyAccessTracerProxy.fmt` need docstrings
Moved class docstring to init method, which is explicitely allowed by the
dev manual you mentioned.
> * An author block and a copyright block are necessary at the top of the
file. See [http://www.sagemath.org/doc/developer/coding_basics.html
#headings-of-sage-library-code-files here].
Done that, thanks!
> * While you're at it, why not expand the documentation? This could be
useful much more generally, and a very short description at the top of the
document would help explain what it does.
I wrote some text at the beginning of the file to indicate what kind of
code I'd eventually expect to be contained in this module. I think that my
tracing code might not remain the only fixture, therefore limiting the
documentation to just that seems like a bad restriction. I did however
extend the documentation of the relevant classes as well, so they might
now be easier to use on their own.
> * It doesn't make sense to leave `fixtures.py` out of the reference
manual. I think you add it by adding a line in
`src/doc/en/reference/doctest/index.rst`, but I may be misremembering.
Worked fine, thanks!
> * There are two tests in `doctest/control.py` that need to be updated
because of the new fixtures file. Otherwise all tests pass.
Oh! I hadn't thought to run doctests in what I considered unrelated files,
thanks for doing that! Fixed now.
----
New commits:
||[http://git.sagemath.org/sage.git/commit/?id=ecdc1bb29405fabd82f2f31321d585acefeee83e
ecdc1bb]||{{{Introduce method tracing fixture.}}}||
||[http://git.sagemath.org/sage.git/commit/?id=771948a52e02d77f99d6dc3d85155371a4aa7cbb
771948a]||{{{Address issues from first review.}}}||
||[http://git.sagemath.org/sage.git/commit/?id=2cbaa017f5ac21c48d49a4ae4885dfcfe064e415
2cbaa01]||{{{Split property access tracing into proxy and helper
classes.}}}||
||[http://git.sagemath.org/sage.git/commit/?id=f6334543439b49ded6ef7486b881d21817078e85
f633454]||{{{Improve documentation style.}}}||
||[http://git.sagemath.org/sage.git/commit/?id=8afc55386e90160f14b917abfde096de9ee6e196
8afc553]||{{{Turn reproducible_repr from a class method to a standalone
function.}}}||
||[http://git.sagemath.org/sage.git/commit/?id=b89fb603fce4e71a535b5bbf4bc052a70b33999d
b89fb60]||{{{Use term attribute instead of property.}}}||
--
Ticket URL: <http://trac.sagemath.org/ticket/17571#comment:2>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.
