Skip to content

[#1653] docs: fix formatting in router.rst#1654

Closed
LagrangeH wants to merge 1 commit intoaiogram:dev-3.xfrom
LagrangeH:#1653-fix
Closed

[#1653] docs: fix formatting in router.rst#1654
LagrangeH wants to merge 1 commit intoaiogram:dev-3.xfrom
LagrangeH:#1653-fix

Conversation

@LagrangeH
Copy link

@LagrangeH LagrangeH commented Mar 14, 2025

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.

Fixes #1653

Type of change

Please delete options that are not relevant.

  • Documentation (typos, code examples or any documentation update)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A
  • Test B

Test Configuration:

  • Operating System:
  • Python version:

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@github-actions github-actions bot added the 3.x Issue or PR for stable 3.x version label Mar 14, 2025
@github-actions
Copy link

github-actions bot commented Mar 14, 2025

🌽 Changelog is not needed.

This PR does not require a changelog because skip news label is present.

@JrooTJunior JrooTJunior added the skip news Pull request can be merged without describing changes label Mar 15, 2025
.. code-block:: python
:caption: module_1.py
:name: module_1
# module_1
Copy link
Member

Choose a reason for hiding this comment

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

The problem you described is caused by incorrect indentation, so you should simply add 4 spaces before the :name: ​​property instead of replacing it with a comment.

.. code-block:: python
:caption: module_2.py
:name: module_2
# module_2
Copy link
Member

Choose a reason for hiding this comment

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

The same.

JrooTJunior pushed a commit that referenced this pull request Apr 5, 2025
* fix(docs): fix formatting in router.rst

* chore(changelog): add entry for #1666
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

3.x Issue or PR for stable 3.x version skip news Pull request can be merged without describing changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: broken formatting

2 participants