Opened 5 years ago
Closed 3 years ago
#23614 closed defect (fixed)
Remove $SAGE_PATH from the documentation
Reported by:  mderickx  Owned by:  

Priority:  minor  Milestone:  sage8.6 
Component:  documentation  Keywords:  days94 
Cc:  vdelecroix, embray, vklein  Merged in:  
Authors:  Tomer Bauer  Reviewers:  Jeroen Demeyer, Erik Bray 
Report Upstream:  N/A  Work issues:  
Branch:  de3eb46 (Commits, GitHub, GitLab)  Commit:  de3eb468fee8057f5df03bf5cb273d90be628042 
Dependencies:  Stopgaps: 
Description
At #22608 the environment variable $PYTHONPATH
was not set anymore and this got merged into 8.0. But this also breaks the usage of $SAGE_PATH
. However $SAGE_PATH
is still mentioned in the documentation of sage 8.0 (there might be more examples then just this link.
It should be mentioned at the relevant places in the sage documentation that $SAGE_PATH
does not work anymore since sage8.0, and suggest the use of $PYTHONPATH
instead.
Change History (16)
comment:1 Changed 5 years ago by
 Keywords beginner added
comment:2 Changed 5 years ago by
comment:3 Changed 5 years ago by
 Keywords beginner removed
I'm not sure I would consider this a "beginner" issue. Although updating the docs is simple to do technically, documenting changes to environment variables like this requires good understanding of the impact of those changes.
comment:4 Changed 4 years ago by
 Branch set to u/mathzeta2/23614_sage_path_doc_update
 Commit set to 89f1e8535c9e738e2db57f47ba8190736b0aa55c
 Status changed from new to needs_review
A suggestion for improvement over the current state.
The links redirect to the Python 3 docs, but they are similar to the Python 2.7 docs.
comment:5 Changed 4 years ago by
 Keywords days94 added
comment:6 Changed 4 years ago by
 Reviewers set to Jeroen Demeyer
 Status changed from needs_review to positive_review
comment:7 Changed 4 years ago by
I'm skeptical of even adding PYTHONPATH
. Users who use PYTHONPATH
willynilly without really understanding what they're doing (e.g. pointing it to some system python's sitepackages) often create trouble for themselves.
I would prefer if Sage came with virtualenv and that there were documentation on how to use it properly with Sage. But that's beyond the scope of this issue. I just don't know about documenting PYTHONPATH
here...
comment:8 Changed 4 years ago by
 Status changed from positive_review to needs_work
comment:9 Changed 4 years ago by
Does that mean you agree? I'm just putting the idea out there for discussion.
comment:10 Changed 4 years ago by
Yes, I think that you have a good point.
comment:11 Changed 4 years ago by
I could write something up about that (or crib some text from something I've written elsewhere, if I can find it...)
comment:12 Changed 4 years ago by
 Commit changed from 89f1e8535c9e738e2db57f47ba8190736b0aa55c to de3eb468fee8057f5df03bf5cb273d90be628042
Branch pushed to git repo; I updated commit sha1. New commits:
de3eb46  Remove documentation mentioning SAGE_PATH

comment:13 Changed 4 years ago by
 Status changed from needs_work to needs_review
An updated commit that removes mentions of SAGE_PATH and PYTHONPATH. Because SAGE_PATH was removed more than a year ago, this might be appropriate.
Documenting Python's environment variables usage in Sage (e.g. Sage does not like users setting PYTHONHOME), can probably go to another ticket.
comment:14 Changed 3 years ago by
This ticket is waiting for its review
comment:15 Changed 3 years ago by
 Component changed from misc to documentation
 Milestone changed from sage8.1 to sage8.6
 Priority changed from major to minor
 Reviewers changed from Jeroen Demeyer to Jeroen Demeyer, Erik Bray
 Status changed from needs_review to positive_review
comment:16 Changed 3 years ago by
 Branch changed from u/mathzeta2/23614_sage_path_doc_update to de3eb468fee8057f5df03bf5cb273d90be628042
 Resolution set to fixed
 Status changed from positive_review to closed
Hey I want to contribute in this ticket where should i start from??