Skip to content

Conversation

dcoudert
Copy link
Contributor

Use more block-scope tags to avoid doctest warnings like

File "src/sage/libs/coxeter3/coxeter.pyx", line 1198, in sage.libs.coxeter3.coxeter.CoxGroupIterator.__next__
Warning: Consider using a block-scoped tag by inserting the line 'sage: # optional - coxeter3' just before this line to avoid repeating the tag 4 times
    from sage.libs.coxeter3.coxeter import get_CoxGroup as CoxGroup, CoxGroupIterator # optional - coxeter3

📝 Checklist

  • The title is concise, informative, and self-explanatory.
  • 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 accordingly.

⌛ Dependencies

@mkoeppe
Copy link
Contributor

mkoeppe commented Dec 17, 2023

Could use file-level tag for these, I think

@dcoudert
Copy link
Contributor Author

This is much cleaner this way.

Copy link

Documentation preview for this PR (built with commit f89bc02; changes) is ready! 🎉

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

vbraun pushed a commit to vbraun/sage that referenced this pull request Dec 21, 2023
sagemathgh-36902: `src/sage/libs/coxeter3/`: fix doctest warnings
    
Use more block-scope tags to avoid doctest warnings like
```
File "src/sage/libs/coxeter3/coxeter.pyx", line 1198, in
sage.libs.coxeter3.coxeter.CoxGroupIterator.__next__
Warning: Consider using a block-scoped tag by inserting the line 'sage:
# optional - coxeter3' just before this line to avoid repeating the tag
4 times
    from sage.libs.coxeter3.coxeter import get_CoxGroup as CoxGroup,
CoxGroupIterator # optional - coxeter3
```

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [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.
- [ ] I have updated the documentation accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#36902
Reported by: David Coudert
Reviewer(s): Matthias Köppe
vbraun pushed a commit to vbraun/sage that referenced this pull request Dec 22, 2023
sagemathgh-36902: `src/sage/libs/coxeter3/`: fix doctest warnings
    
Use more block-scope tags to avoid doctest warnings like
```
File "src/sage/libs/coxeter3/coxeter.pyx", line 1198, in
sage.libs.coxeter3.coxeter.CoxGroupIterator.__next__
Warning: Consider using a block-scoped tag by inserting the line 'sage:
# optional - coxeter3' just before this line to avoid repeating the tag
4 times
    from sage.libs.coxeter3.coxeter import get_CoxGroup as CoxGroup,
CoxGroupIterator # optional - coxeter3
```

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [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.
- [ ] I have updated the documentation accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#36902
Reported by: David Coudert
Reviewer(s): Matthias Köppe
vbraun pushed a commit to vbraun/sage that referenced this pull request Dec 23, 2023
sagemathgh-36902: `src/sage/libs/coxeter3/`: fix doctest warnings
    
Use more block-scope tags to avoid doctest warnings like
```
File "src/sage/libs/coxeter3/coxeter.pyx", line 1198, in
sage.libs.coxeter3.coxeter.CoxGroupIterator.__next__
Warning: Consider using a block-scoped tag by inserting the line 'sage:
# optional - coxeter3' just before this line to avoid repeating the tag
4 times
    from sage.libs.coxeter3.coxeter import get_CoxGroup as CoxGroup,
CoxGroupIterator # optional - coxeter3
```

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [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.
- [ ] I have updated the documentation accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#36902
Reported by: David Coudert
Reviewer(s): Matthias Köppe
vbraun pushed a commit to vbraun/sage that referenced this pull request Dec 24, 2023
sagemathgh-36902: `src/sage/libs/coxeter3/`: fix doctest warnings
    
Use more block-scope tags to avoid doctest warnings like
```
File "src/sage/libs/coxeter3/coxeter.pyx", line 1198, in
sage.libs.coxeter3.coxeter.CoxGroupIterator.__next__
Warning: Consider using a block-scoped tag by inserting the line 'sage:
# optional - coxeter3' just before this line to avoid repeating the tag
4 times
    from sage.libs.coxeter3.coxeter import get_CoxGroup as CoxGroup,
CoxGroupIterator # optional - coxeter3
```

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [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.
- [ ] I have updated the documentation accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#36902
Reported by: David Coudert
Reviewer(s): Matthias Köppe
@vbraun vbraun merged commit 6c1811d into sagemath:develop Dec 26, 2023
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