search

sagemath / sage

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

Clean up documentation of orthogonal polynomials #31636

Open mjungmath opened 3 years ago

mjungmath commented 3 years ago

Currently, the documentation for orthogonal polynomials is not very user-friendly (see https://doc.sagemath.org/html/en/reference/functions/sage/functions/orthogonal_polys.html).

Some functions miss examples. The end-user syntax is not clearly communicated either.

Moreover, most references are pointing at Wikipedia which should be changed imho. This is not reliable in the sense that an article can use different conventions tomorrow whereas books use fixed conventions.

I suggest to clean this up.

CC: @sagetrac-jcwomack @slel @egourgoulhon

Component: misc

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

mjungmath commented 3 years ago

Description changed:

--- 
+++ 
@@ -1,6 +1,6 @@
 Currently, the documentation for orthogonal polynomials is not very user-friendly (see https://doc.sagemath.org/html/en/reference/functions/sage/functions/orthogonal_polys.html).

-Some functions miss examples, some examples are not even related to the specific function. The end-user syntax is not clearly communicated either.
+Some functions miss examples. The end-user syntax is not clearly communicated either.

 Moreover, most references are pointing at Wikipedia which should be changed imho. This is not reliable in the sense that an article can use different conventions tomorrow whereas books use fixed conventions.