Skip to content

Commit

Permalink
gh-38041: Installation Guide: Remove some distracting wikipedia links
Browse files Browse the repository at this point in the history 
    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes #12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes #12345". -->

These links send users to generic definitions of the terms "Source code"
and "HTML", which is not helpful and can be a distraction, in particular
when users expect to be sent to a project-specific target. As of 2024,
web browsers typically have convenient UI shortcuts for looking up
unfamiliar terms.

For "Source code", this was reported in
https://groups.google.com/g/sage-devel/c/bI_jPOJoyRc/
Removing the link implements my suggestion in
#37791 (comment)


### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - #12345: short description why this is a dependency -->
<!-- - #34567: ... -->
    
URL: #38041
Reported by: Matthias Köppe
Reviewer(s): gmou3
  • Loading branch information
Release Manager committed May 23, 2024
2 parents 8b08434 + 6b69a0b commit 4f8a407
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions src/doc/en/installation/source.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Install from Source Code
========================

Building Sage from the :wikipedia:`source code <Source_code>` has the major
Building Sage from the source code has the major
advantage that your install will be optimized for your particular computer and
should therefore offer better performance and compatibility than a binary
install.
Expand Down Expand Up @@ -602,8 +602,9 @@ Make targets
------------

To build Sage from scratch, you would typically execute ``make`` in Sage's home
directory to build Sage and its :wikipedia:`HTML <HTML>`
documentation.
directory to build Sage and its documentation in HTML format, suitable for
viewing in a web browser.

The ``make`` command is pretty smart, so if your build of Sage is interrupted,
then running ``make`` again should cause it to pick up where it left off.
The ``make`` command can also be given options, which control what is built and
Expand Down

0 comments on commit 4f8a407

Please sign in to comment.