#8680: untabify Sage again, and make it stick
-----------------------------+----------------------------------------------
Reporter: jhpalmieri | Owner: jason
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-4.4
Component: misc | Keywords:
Author: John Palmieri | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
-----------------------------+----------------------------------------------
Comment(by mvngu):
Replying to [comment:3 jhpalmieri]:
> Okay, here's a new version implementing that. It's only documented at
the top of sage-doctest (and as a comment in the code later) because I
didn't know where else to put it.
Eventually, the new variable `SAGE_DOCTEST_ALLOW_TABS` would need to be
documented in the Developer's Guide, along with all others defined by
Sage. Ticket #8263 keeps track of this issue.
[[BR]][[BR]]
> Minh, do you have any opinions?
Explicitly disallowing TABs is just one of many tasks in sanitizing a
patch before the patch is committed. I recall a few months ago, the sage-
combinat team had a discussion about creating a new script for the script
repository. The purpose of this script was to sanitize the commit message
of a patch. In particular, the commit message must contain the ticket
number. I think it's time we think about writing such a script called,
say, `sage-sanitize`. As a tentative list of rules to check for, `sage-
sanitize` would check for the following in a patch:
* TAB characters
* The preamble of a Mercurial patch, which consists at minimum of the
following:
{{{
# HG changeset patch
# User <Your Name> [email protected]
# Date
# Node
# Parent
#xxxx: <commit message goes here>
}}}
I'm in favour of automating as much as possible tedious tasks such as the
above. An advantage is that prior to reviewing a patch, a reviewer (or
indeed a continuous integration system) could run a patch through this
sanity checker script. If all rules in the script pass, then the reviewer
could then proceed with reviewing the implementation contained in the
patch.
[[BR]][[BR]]
If you agree, a ticket could be opened for this new `sage-sanitize`
script.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/8680#comment:4>
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 post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
