Menu
▾
▴
#1217 clean up undocumented regtests in 2.14.0.
Originally created by: *anonymous
Originally created by: percival.music.ca@gmail.com
Strictly speaking, we shouldn't hold up 2.14 if a new feature in 2.13 is only documented as a regtest -- the guideline for a new stable release is "should not be worse than the previous one", and missing docs is "not worse".
So I'm separating 989 into two issues. 989 is for anything that was in 2.12.3 and is not documented; this issue is for anything that [will be] in 2.14.0 and is not documented. Serious work on this issue therefore can't start until 2.14 is out.
After 2.14.0, we can get a list of altered/added regtests with:
git diff -u -r release/2.14.0-1 -r release/2.15.13-1 input/regression/
(alter tags as appropriate)
so once this issue is closed, we shouldn't ever need to slog through the entire list of regtests.
Frog: (this is an ideal way to get accustomed with the docs) 10 hours if you're organized and/or don't suffer communication breakdowns in a team.
Originally posted by: brownian.box@gmail.com
"Document \breakDynamicSpan" by Reinhold Kainhofer:
http://lists.gnu.org/archive/html/bug-lilypond/2010-10/msg00560.html
Originally posted by: percival.music.ca@gmail.com
(No comment was entered for this change.)
Labels: -Priority-High Priority-Medium
Originally posted by: pkx1...@gmail.com
Phil, do you want to do what we did last time? Use that Wiki to list what we need to do (if anything) so I can eaisly keep track of my progress?
That seemed to work quite well for 989 and is less messy than a single thread like this.
There may be not that much to do - I know footnotes is one and I'm just finishing up \cueClef, so those are two that I know about off the top of my head - assuming RK has added his reg tests yet.
james
Originally posted by: PhilEHol...@googlemail.com
Works for me. Would want Graham to agree. Could you check you can still access and edit the wiki - I think I had some problems last time I tried.
Originally posted by: percival.music.ca@gmail.com
I agree in principle, but I'd prefer a tweak: I want James to be supervising the regtest stuff. He can copy&paste stuff into the docs, but I want other people to be doing the legwork.
PREPARATION
- James makes sure he can edit the wiki. If relevant, James also gets admin on the wiki, so that he can authorize new users to edit pages. (that may or may not be necessary)
- James emails lilypond-user, asking for volunteers to work on this. He explains that we need people to look through regtests, we need people to explain how a regtest works (in 2-3 sentences), we need people to make minor changes to the .ly files to make them more doc-friendly.
WORKLOAD
- people add "missing regtests" to the wiki
- other people, or maybe the same people, write (in email form) documentation for each feature.
- James dumps them in Notation, adds whatever minor formatting is required, maybe adds a few @seealso if necessary -- but no more than 15 minutes of work for each new feature. Anything that would take longer than that gets kicked back to volunteers.
We need fresh blood in the documentation stream, and I cannot supervise them without abandoning GOP and/or GLISS. Since each new feature here is very limited in scope, this is an ideal task for him to start supervising people.
Originally posted by: percival.music.ca@gmail.com
(No comment was entered for this change.)
Labels: -Maintainability Type-Maintainability