Skip to content

Fix typos and outdated links in igraph_graph() docs#38407

Merged
vbraun merged 2 commits intosagemath:developfrom
szhorvat:patch-1
Aug 3, 2024
Merged

Fix typos and outdated links in igraph_graph() docs#38407
vbraun merged 2 commits intosagemath:developfrom
szhorvat:patch-1

Conversation

@szhorvat
Copy link
Contributor

@szhorvat szhorvat commented Jul 22, 2024

This PR simply fixes typos and updates broken links in the documentation here: https://doc.sagemath.org/html/en/reference/graphs/sage/graphs/generic_graph.html#sage.graphs.generic_graph.GenericGraph.igraph_graph

📝 Checklist

  • The title is concise and informative.
  • The description explains in detail what this PR is about.
  • 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

@github-actions
Copy link

github-actions bot commented Jul 22, 2024

Documentation preview for this PR (built with commit 50ff868; changes) is ready! 🎉
This preview will update shortly after each push to this PR.

@szhorvat
Copy link
Contributor Author

There's a piece of text (0, \ldots, n-1) which should be rendered in math mode instead of as code. I am not sure how to do this, help would be appreciated.

@mkoeppe
Copy link
Contributor

mkoeppe commented Jul 23, 2024

use single backquotes for math

@szhorvat
Copy link
Contributor Author

I checked the documentation preview and I believe this is now ready to go.

Copy link
Contributor

@mkoeppe mkoeppe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks.

vbraun pushed a commit to vbraun/sage that referenced this pull request Jul 25, 2024
sagemathgh-38407: Fix typos and outdated links in `igraph_graph()` docs
    
<!-- ^ 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 sagemath#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 sagemath#12345". -->

This PR simply fixes typos and updates broken links in the documentation
here: https://doc.sagemath.org/html/en/reference/graphs/sage/graphs/gene
ric_graph.html#sage.graphs.generic_graph.GenericGraph.igraph_graph

### 📝 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.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [x] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#38407
Reported by: Szabolcs Horvát
Reviewer(s): Matthias Köppe
vbraun pushed a commit to vbraun/sage that referenced this pull request Jul 31, 2024
sagemathgh-38407: Fix typos and outdated links in `igraph_graph()` docs
    
<!-- ^ 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 sagemath#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 sagemath#12345". -->

This PR simply fixes typos and updates broken links in the documentation
here: https://doc.sagemath.org/html/en/reference/graphs/sage/graphs/gene
ric_graph.html#sage.graphs.generic_graph.GenericGraph.igraph_graph

### 📝 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.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [x] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#38407
Reported by: Szabolcs Horvát
Reviewer(s): Matthias Köppe
vbraun pushed a commit to vbraun/sage that referenced this pull request Aug 2, 2024
sagemathgh-38407: Fix typos and outdated links in `igraph_graph()` docs
    
<!-- ^ 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 sagemath#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 sagemath#12345". -->

This PR simply fixes typos and updates broken links in the documentation
here: https://doc.sagemath.org/html/en/reference/graphs/sage/graphs/gene
ric_graph.html#sage.graphs.generic_graph.GenericGraph.igraph_graph

### 📝 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.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [x] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#38407
Reported by: Szabolcs Horvát
Reviewer(s): Matthias Köppe
@vbraun vbraun merged commit a064ca7 into sagemath:develop Aug 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants