improve language in desolve.py

[rwst]

Several omissions of articles, wording, and typos need to be fixed in this highly visible module.

Component: documentation

Keywords: calculus documentation

Author: Ralf Stephan

Branch/Commit: e03b5c8

Reviewer: Frédéric Chapoton, Karl-Dieter Crisman

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

[rwst]

Branch: u/rws/ticket/15812

[rwst]

New commits:

b3544d7

trac 15812: fix omissions of articles, wording, and typos

[rwst]

Commit: b3544d7

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

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

f6cef26

Merge branch 'develop' into ticket/15812

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from b3544d7 to f6cef26

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from f6cef26 to ec74e60

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

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

ec74e60

Merge branch 'develop' into ticket/15812

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from ec74e60 to c46ad14

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

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

c46ad14

Merge branch 'develop' (6.2.beta4) into ticket/15812

[kcrisman]

comment:6

Most of this seems fine. Keep in mind that the initial work was done by a native Slavic-language speaker, if I recall correctly, so perhaps lacking articles is not a surprise. Also, I don't have an opinion on whether we need periods for the option list. I do have one question:

In most cases returns SymbolicEquation

So, is the output block saying what the function does (so, needs "returns") or giving a command (so, needs "return")? Or perhaps some third option (like "returns a")? I usually like the first option, but I don't recall if there is a policy.

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from c46ad14 to 7ab44db

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

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

7ab44db

adhere to return/returns doc convention

[rwst]

comment:8

There is indeed a convention, and it argues against the "returns" form: http://sagemath.org/doc/developer/coding_basics.html#docstring-markup-with-rest-and-sphinx

The commit adapts the text to it, finally. Thanks for the hint.

[kcrisman]

comment:9

Ah, I thought maybe that had been clarified recently. Glad I wasn't dreaming it.

Another thing found in a few places:

Initials conditions are optional.

Maybe "initial"?

And:

Higher ordered, 

Probably is "higher order".

Do you want "laplace" capitalized?

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from 7ab44db to bd0777e

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

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

8dc4d9e	15812: more typos fixed
bd0777e	Merge branch 'develop' into t/15812/ticket/15812

[kcrisman]

comment:11

And:

Higher ordered, 

Probably is "higher order".

I want to give this positive review, but this isn't fixed. Idiomatic (English) for diffeqs is "higher order", not "higher ordered", whether or not one appends "equation".

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from bd0777e to e93893d

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

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

e93893d

15812: corrections of language

[fchapoton]

comment:14

There remains at least one "laplace" without capitals

Solve an ODE using laplace transforms

There also remains at least one typo "singlar"

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

Changed commit from e93893d to e03b5c8

[7ed8c4ca-6d56-4ae9-953a-41e42b4ed313]

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

e03b5c8

15812: more typos fixed

[kcrisman]

Reviewer: Frédéric Chapoton, Karl-Dieter Crisman

[kcrisman]

comment:16

chapoton, I'm happy with this now in principle - if you find the documentation still builds correctly, it shouldn't affect any doctests so you can change to positive review.

[fchapoton]

comment:17

ok, then good to go.

[vbraun]

Changed branch from u/rws/ticket/15812 to e03b5c8