sagemath / sage

Main repository of SageMath
https://www.sagemath.org
Other
1.45k stars 482 forks source link

Documentation Improvements of Characteristic Classes #28854

Closed b220a61f-8dcb-4d62-9a53-d56a2b1bfc8f closed 4 years ago

b220a61f-8dcb-4d62-9a53-d56a2b1bfc8f commented 4 years ago

In order to avoid misunderstandings, the term 'genus' was removed in the documentation. Actually, in terms of topology this expression even seems to be wrong for the additive case!

CC: @egourgoulhon @tscrim

Component: geometry

Keywords: characteristic classes, vector bundles

Author: Michael Jung

Branch/Commit: a94b358

Reviewer: Varenyam Bakshi

Issue created by migration from https://trac.sagemath.org/ticket/28854

b220a61f-8dcb-4d62-9a53-d56a2b1bfc8f commented 4 years ago

Branch: u/gh-DeRhamSource/documentation_improvements_of_characteristic_classes

b220a61f-8dcb-4d62-9a53-d56a2b1bfc8f commented 4 years ago

New commits:

d557f43Trac #28854: term 'genus' removed in documentation
b220a61f-8dcb-4d62-9a53-d56a2b1bfc8f commented 4 years ago

Commit: d557f43

b220a61f-8dcb-4d62-9a53-d56a2b1bfc8f commented 4 years ago

Description changed:

--- 
+++ 
@@ -1 +1,3 @@
+In order to avoid possible misunderstandings, the term 'genus' was removed in the documentation.

+Perhaps some more improvements will come.
b220a61f-8dcb-4d62-9a53-d56a2b1bfc8f commented 4 years ago

Changed keywords from none to characteristic classes, vector bundles

b220a61f-8dcb-4d62-9a53-d56a2b1bfc8f commented 4 years ago

Author: Michael Jung

b220a61f-8dcb-4d62-9a53-d56a2b1bfc8f commented 4 years ago
comment:3

Please give it a positive review as soon as possible. Thanks! :)

b220a61f-8dcb-4d62-9a53-d56a2b1bfc8f commented 4 years ago

Description changed:

--- 
+++ 
@@ -1,3 +1 @@
-In order to avoid possible misunderstandings, the term 'genus' was removed in the documentation.
-
-Perhaps some more improvements will come.
+In order to avoid misunderstandings, the term 'genus' was removed in the documentation. Actually, in terms of topology this expression even seems to be wrong for the additive case!
b220a61f-8dcb-4d62-9a53-d56a2b1bfc8f commented 4 years ago
comment:4

We are at beta9 already. Still, is it likely to have this change in Sage9?

tscrim commented 4 years ago
comment:6

I don't feel qualified enough to be able to answer this as it is not my area of expertise. I might be able to grab a geometer to check it, but I cannot promise that. I can say at least the changes are code-wise correct.

Eric, this is essentially a trivial ticket, can you quickly check it?

b220a61f-8dcb-4d62-9a53-d56a2b1bfc8f commented 4 years ago
comment:7

The description should be correct now. The names are chosen quite general. Still, I feel not comfortable reviewing my own modifications.

If you could grab a geometer, it would be certainly nice. But I think this is not necessary. I could ask my supervisor next week and modify the documentation at some later point if necessary.

However, the term 'genus' is certainly wrong and it would be nice not having this into the final Sage version.

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 4 years ago

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

6eca01dMerge branch 'develop' into t/28854/documentation_improvements_of_characteristic_classes
7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 4 years ago

Changed commit from d557f43 to 6eca01d

embray commented 4 years ago
comment:10

Ticket retargeted after milestone closed

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 4 years ago

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

a94b358Trac #28854: Merge branch 'develop' into t/28854/documentation_improvements_of_characteristic_classes
7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 4 years ago

Changed commit from 6eca01d to a94b358

b220a61f-8dcb-4d62-9a53-d56a2b1bfc8f commented 4 years ago
comment:12

Would you mind to give it a positive review? Thanks! :)

tscrim commented 4 years ago
comment:13

Eric, would you be able to do the review?

252a9631-90fd-4d3d-aafa-1c9c0f216f59 commented 4 years ago

Reviewer: gh-varenyamBakshi

252a9631-90fd-4d3d-aafa-1c9c0f216f59 commented 4 years ago
comment:14

the change in documentation looks ok to me. This should be done in the new version of sage.

252a9631-90fd-4d3d-aafa-1c9c0f216f59 commented 4 years ago

Changed reviewer from gh-varenyamBakshi to Varenyam bakshi

tscrim commented 4 years ago
comment:16

Eric, can you take a look at this quickly to make sure it is okay?

egourgoulhon commented 4 years ago
comment:18

Replying to @tscrim:

Eric, can you take a look at this quickly to make sure it is okay?

Sorry for the delay in replying. I was not aware of this ticket, due to the mispelling of my username in the CC. Besides, when you open such ticket, please add it to the metaticket #18528 to increase its visibility.

Yes, it is okay for me. I am setting the ticket back to positive review.

tscrim commented 4 years ago
comment:20

Thank you.

tscrim commented 4 years ago

Changed reviewer from Varenyam bakshi to Varenyam Bakshi

vbraun commented 4 years ago

Changed branch from u/gh-DeRhamSource/documentation_improvements_of_characteristic_classes to a94b358