Opened 8 years ago

Last modified 6 years ago

#13962 needs_work enhancement

Small improvements to Boolean polynomial docs

Reported by: malb Owned by: mvngu
Priority: major Milestone: sage-6.4
Component: documentation Keywords:
Cc: PolyBoRi, AlexanderDreyer Merged in:
Authors: Reviewers: knsam
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Description

At #13849 Michael suggested to encourage Sage users more to look at the PolyBoRi? (lowlevel) docs.

Attachments (1)

trac_13962_polybori_docs.patch (5.4 KB) - added by malb 8 years ago.

Download all attachments as: .zip

Change History (12)

comment:2 Changed 8 years ago by AlexanderDreyer

Hm, fine with that. But shouldn't you update your email adress?

Changed 8 years ago by malb

comment:3 Changed 8 years ago by malb

Okay, I've dropped it completely.

comment:4 Changed 8 years ago by knsam

  • Reviewers set to knsam

comment:5 in reply to: ↑ 1 Changed 8 years ago by knsam

Replying to malb:

See http://sage.math.washington.edu/home/malb/scratch/sage-5.5/devel/sage/doc/output/html/en/reference/sage/rings/polynomial/pbori.html for typeset documentation.

That this is about looking at the Documentation for PolyBoRi?, I'd like to suggest the following for a start(based on the typeset documentation you linked to):

General Observation: Please use \langle and \rangle to typeset < and > respectively. We might also want care for the plurality whenever relevant: like EXAMPLES.

Specifics (I am commenting on the present state, and I would like some docstrings to be more descriptive):

  1. In the introduction, the {0,1} is being codified while it should be really typeset.

Example

  1. "that is the ideals J satisfying I \subset J \subset P" -- P is an undefined piece of notation; Also, we really want \subseteq.

BooleConstant?

  1. The function has_constant_part() has the word "for" repeated twice. And, the BooleConstant?(1) bit needs to be codified.
  2. is_constant docstring sounds slightly awkard grammatically.
  3. variables(): "and" is a typo, I guess.

BooleSet?

  1. diff: Use \setminus may be?
  2. intersect: "union" is really intersection.

BooleanSetIterator?

  1. iterindex(): indices is misspelt.

BooleanMonomialIterator?

  1. codify StopIteration?.
  2. gen: codify self

BooleanMonomialVariableIterator?

  1. codify StopIteration?

BooleanPolynomial?

  1. is_one: codify self.
  2. is_univariate: codify self.
  3. lex_lead(): The term "lexicographical term ordering" sounds unfamiliar to me. Is "term" a part of the common usage?

BooleanPolynomialRing?

  1. The class description relies on the INPUT section, perhaps not a good idea. The default value for order (lex) needs to be codified.
  2. clone: Indentation issue and also codify ring.clone...
  1. etc... [What I mean is, I'd get back with more comments, perhaps at a level not as superficial as the ones here. I know these are minor, but for a start...]

There are some part where we could illustrate the necessary conditions in the Examples. I'll go through more carefully to point out such cases.

comment:6 Changed 8 years ago by knsam

  • Status changed from needs_review to needs_work

comment:7 Changed 8 years ago by malb

I won't be getting around to fixing these in the next few days, so if you provide a patch I can look at it once I have a bit of free time.

comment:8 Changed 7 years ago by jdemeyer

  • Milestone changed from sage-5.11 to sage-5.12

comment:9 Changed 7 years ago by vbraun_spam

  • Milestone changed from sage-6.1 to sage-6.2

comment:10 Changed 7 years ago by vbraun_spam

  • Milestone changed from sage-6.2 to sage-6.3

comment:11 Changed 6 years ago by vbraun_spam

  • Milestone changed from sage-6.3 to sage-6.4
Note: See TracTickets for help on using tickets.