Improving Coding Style and Documentation in projective product schemes

[rlmiller]

There are number of coding style issues and documentation issues in the affine scheme functionality such as

• == False or == True
• references to self in docs
• no single line description
• formatting of errors

[rlmiller]

Last 10 new commits:

​25e1132	Trac 17785: fix segmentation fault for subs
​bf8ee82	#19880 update openssl to 1.0.2e
​ccf6ad4	Updated Sage version to 7.0.rc1
​a8b26fe	Deprecate composite_field()
​0214b33	Move sage.rings.arith to sage.arith.misc
​bcd965d	Improve location change error message
​d41d5cb	Raise an error if Sage has been relocated
​b5ed4aa	Updated Sage version to 7.0
​ec0093e	19979 Fixing in style in projective products
​8264cab	19979 Fixing style of Product Projective folder

[rlmiller]

Something went wrong with the rebase. Here is a corrected branch.

---

New commits:

​10f66b4

19979 Improve coding for product projectives

[git]

Branch pushed to git repo; I updated commit sha1. New commits:

​a5b0974

Merge branch 'master' into t/19979/t/19979

[rlmiller]

Something went wrong with the rebase. Here is a corrected branch.

---

New commits:

​10f66b4	19979 Improve coding for product projectives
​a5b0974	Merge branch 'master' into t/19979/t/19979

---

New commits:

​10f66b4	19979 Improve coding for product projectives
​a5b0974	Merge branch 'master' into t/19979/t/19979

[bhutz]

merge conflict with the latest beta.

[git]

Branch pushed to git repo; I updated commit sha1. New commits:

​1803633	Merge branch 'master' into t/19979/t/19979
​7ddbc55	19979 Updating style of Product Projective folder

[bhutz]

The docs don't build:

[schemes  ] /home/ben/sage/sage-test/local/lib/python2.7/site-
packages/sage/schemes/product_projective/space.py:docstring of 
sage.schemes.product_projective.space.is_ProductProjectiveSpaces:1: WARNING: Inline interpreted text or phrase reference start-string without end-string.

wehlerK3: I started looking at this line by line, but there are many repeating issues so I'll look at this file line-by-line after you make another pass.

• no spaces after ( or before )
• bilinear is spelled wrong many times

here are the first few instances of these:

• import spacing
• line 72 bilinear misspelled
• line 75: OUTPUT: :class:WehlerK3Surface_ring
• line 102: no space for (space
• 106: bilinear
• 110 OUTPUT: :class:WehlerK3Surface_ring
• 118 wrap line
• 129: no spaces before/after (, )
• 135: bilinear
• 150, 159, 161, 163, 166, 168, 170, 173: paren space
• 182 output
• 199 paren space, no need for () around return
• 207 AttributeError?, True if point is on surface
• 243 paren space
• 245 need better one line description
• 249, 251, 261, 285, 287 paren space
• 291 better one line description

Here is what I saw in the other files:

space.py:

• is_ProduceProjectiveSpaces: shorter one line description
• 137: spaces
• 428 one line
• 443 ending punc
• 447 .
• 549 onthis
• 733 R

point.py

• 82: spaces
• 99,103,107 i
• 237 thid
• 294 t
• 333: self
• 351: parameter spaces
• 373: , QQ
• 391 spaces
• 415 n -> N, P is self, so this doc string needs to be reworded
• 417 n -> N, self/P are not right
• 424 self
• 457 spaces
• 460 codomain
• 461 N, space (

morphism.py

• 31 blank line before
• 78, 79, 90, 91: , QQ)
• 124,128,132 i
• 188 , [1,1,1]
• 226 space
• 240 iff -> if and only if
• 323 thus -> this, n -> N
• 359: just start this with "This function..."
• 364 reducing -> reduce
• 389 codomain

[git]

Branch pushed to git repo; I updated commit sha1. New commits:

​5fe2f41

19979 Fixing style of product projective folder

[bhutz]

I made some small additional corrections. You should double check those and see if we've missed anything else.

---

New commits:

​7b099f7

19979: some small additional changes

[rlmiller]

Changes look fine.

[bhutz]

ok. we should be all set here then.

[vbraun]

Author name...

[jdemeyer]

What do you prefer: "Rebecca Lauren Miller" or "Rebecca Miller"?

[kcrisman]

Given that comment:6:ticket:20067 was done by rlmiller while this one was by bhutz, I would guess the "Lauren" version.