#15567: Fix Alphabet and improvements to Family
-------------------------+-------------------------------------------------
       Reporter:         |        Owner:  sage-combinat
  tscrim                 |       Status:  needs_work
           Type:         |    Milestone:  sage-6.1
  defect                 |   Resolution:
       Priority:  major  |    Merged in:
      Component:         |    Reviewers:
  combinatorics          |  Work issues:
       Keywords:         |       Commit:
  alphabet               |  03b3045881fbff482768e4d3efee772c83d58da8
        Authors:         |     Stopgaps:
  Travis Scrimshaw       |
Report Upstream:  N/A    |
         Branch:         |
  public/15567           |
   Dependencies:         |
-------------------------+-------------------------------------------------

Comment (by ncohen):

 Hello !

 > Nathann, you write the documentation then (as a review commit).

 I have absolutely no clue of what this function does. That's the problem.
 Show the documentation above to anybody you meet, and ask him to deduce
 what the function returns. If he gets it I am wrong, otherwise it needs to
 be rewritten.

 > There is no class `Alphabet`; it just is an alias (or you can think of
 it as a facade) for `build_alphabet`. Also IMO, the examples are worth a
 1000 words trying to explain all possible combinations in the docstring
 for the variables.

 Come on. It must be possible to write properly what the arguments actually
 mean `O_o`

 > From Webster: "Hidden (adjective): not seen or known, being out of sight
 or not readily apparent". So they are keys and a function on the keys
 which are not seen or are out of sight.

 Thank you very much. Knowing what "hidden" means actually help.

 Hey Travis, what do you think I am doing here ? Why would I come add
 comments to this ticket just to make it more painful for you ?
 I honestly do not understand what "hidden" means in this context. No way.
 Does it mean that the letters are ignored ? That they just aren't
 displayed but that they are still stored somewhere ? Does this parameter
 have any actual use or should it be removed ?

 That's what I want to find out. I have no idea what it does at the moment.

 > Furthermore, they are a few harmless merges of the `develop` branch in
 the history, but I don't want to wait an hour+ to switch between branches
 and test something in Sage.

 There are 4 commits with unclear commit messages, and these four commits
 are as useful as none, as in the branch I  uploaded. And I never had to
 recompile anything, I do not understand why you bring this up.

 > In fact, on most projects I've seen, the git history consists of many
 very small commits and can be called "messy".

 How do they review stuff if each commit is meaningless ? `O_o`

 Nathann

--
Ticket URL: <http://trac.sagemath.org/ticket/15567#comment:15>
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/groups/opt_out.

Reply via email to