Skip to content

Commit

Permalink
gh-39074: Fix the issue number format in deprecation comment
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". -->

Fixes a typo in the developer guide, noted in
#38207 (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: #39074
Reported by: Kwankyu Lee
Reviewer(s): Frédéric Chapoton
  • Loading branch information
Release Manager committed Dec 8, 2024
2 parents 332147a + 2e7e215 commit 8fc386b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/doc/en/developer/coding_in_python.rst
Original file line number Diff line number Diff line change
Expand Up @@ -786,13 +786,13 @@ the procedure below:
class NewClass:
...
OldClass = NewClass # OldClass is deprecated. See Issue 12345.
OldClass = NewClass # OldClass is deprecated. See Issue #12345.
* **Removing a class:** add a comment:

.. CODE-BLOCK:: python
# OldClass is deprecated. See Issue 12345.
# OldClass is deprecated. See Issue #12345.
class OldClass:
Expand Down

0 comments on commit 8fc386b

Please sign in to comment.