Error in documentation: location of `constants.py`

71 views
Skip to first unread message

Adarsh Kishore

unread,
Mar 25, 2022, 3:51:23 AM3/25/22
to sage-devel
Hi everyone,
I am running Sage v9.6.beta4 on Ubuntu 20.04 LTS. I was going through the online documentation of Sage and I came across this line on https://doc.sagemath.org/html/en/developer/coding_in_python.html
```
Here is an example of the _latex_ and _repr_ functions for the Pi class. It is from the file SAGE_ROOT/src/sage/functions/constants.py
```
Screenshot from 2022-03-25 11-54-44.png

However, there is no constants.py in the mentioned directory. Instead, I found it on my Sage in
```
SAGE_ROOT/src/sage/symbolic/constants.py
```

Screenshot from 2022-03-25 11-52-01.png

Screenshot from 2022-03-25 11-53-58.png

I think the documentation should be updated to reflect this.

Adarsh Kishore

unread,
Mar 25, 2022, 8:12:28 AM3/25/22
to sage-devel
Apart from this, the documentation is outdated in several other places also. For example,  on the same website, for an example on free modules it is mentioned that
```
the following is from the file SAGE_ROOT/sage/sage/modules/free_module_element.pyx
```

However the same is actually now at
```
SAGE_ROOT/src/sage/modules/free_module_element.pyx
```

Also, while explaining the `_matrix_` method, an example is given as

Screenshot from 2022-03-25 17-37-40.png

However, this class is now at
```
SAG_ROOT/src/sage/graphs/generic_graph.py
```

Screenshot from 2022-03-25 17-41-13.png

and I believe several other inconsistencies would be existing.

Eric Gourgoulhon

unread,
Mar 26, 2022, 1:44:45 PM3/26/22
to sage-devel
Hi,

Thanks for spotting these errors in the documentation. Would you open a ticket to fix them?

Best wishes,

Eric.

Adarsh Kishore

unread,
Mar 26, 2022, 1:58:10 PM3/26/22
to sage-devel
Certainly, I will read up on the process of opening a new ticket (this is my first time :)

Adarsh Kishore

unread,
Mar 30, 2022, 4:05:32 AM3/30/22
to sage-devel
Hi,
I have opened https://trac.sagemath.org/ticket/33571 for this purpose. I have also pushed the changes on my branch as I had pointed out. Anything else I can help in?

Reply all
Reply to author
Forward
0 new messages