#13747: Change default behaviour of Poset to facade = True
---------------------------------+------------------------------------------
Reporter: ncohen | Owner: sage-combinat
Type: defect | Status: needs_review
Priority: major | Milestone: sage-5.6
Component: combinatorics | Resolution:
Keywords: | Work issues:
Report Upstream: N/A | Reviewers:
Authors: Nathann Cohen | Merged in:
Dependencies: | Stopgaps:
---------------------------------+------------------------------------------
Comment (by ncohen):
Hellooooooo Christian !!!
> a few remarks from my side:
>
> * Yes, the doc is better :-)
Cool `:-D`
> * I still don't feel very comfortable with the following facade doc: "
the `facade` variable will be set to `True` or `False` by a lower-level
call, or depending on the context." Depending on what context? I believe
the doc should clearly state what influence a certain parameter has.
Ahem. I believe so, too... But from the comments on this ticket you can
see that I just said there what Nicolas gave me to chew. What this ticket
initially contained is a warning like "There are three values for a
boolean instead of three, the third is not well defined and should not be
trusted -- it should be removed eventually or documented". But well,
Nicolasgave me that explanation and honestly I do not mind much leaving it
like that for the moment -- it is still much better than before and it
will take manyyyyyyyyyyyyyyyy patches before this file is cleaned.
Besides, that's not a "local" problem. Facades are used in many places and
I do not expect their documentation to be very different.
> * In the examples you sometimes changed the former default facade value
(i.e. facade = None) to facade = False, in other examples you left the
coding as it was so the examples work with the new defualt value facade =
True. (See 1st and 2nd example of Posets(...)). Not sure whether this
was done on purpose of forgotten
Oh. Yeah, easy. Many explanations usually : as the new default is `facade
= True`, I felt like this should be heavily tested in the docstrings. So
when a docstring did not fail after that change, I left it like that. If
it worked by changing it to `facade = False`, I was happy. If that did not
work either I changed it to `facade = None` which was the former default.
Not that on some other occasions the documentation says "let us us `facade
= True` in the following example", and in those cases (because is was
explicitely said) I let `facade = True` stay, even though it is now the
default too.
> * I think there is one "`" to much in the Output doc of the constructor
(class FinitePoset)
Oh ? Noooooooooo ! Actually, what I want to write is "whether the Poset's
elements", but I wrapped Poset inside of a `:meth:` tag... But it appears
in the documentation as "whether the Poset's elements" as it should, and
Sphinx compiles without warning `:-)`
Nathann
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/13747#comment:10>
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.
