Skip to content

Conversation

@Guts
Copy link
Collaborator

@Guts Guts commented Mar 26, 2025

@Guts Guts requested a review from jmkerloch March 26, 2025 16:10
Copy link
Collaborator

@jmkerloch jmkerloch left a comment

Choose a reason for hiding this comment

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

LGTM 🚀

@Guts Guts merged commit 035e0b3 into main Mar 26, 2025
5 checks passed
@Guts Guts deleted the fix/escaping-chars-in-docstrings branch March 26, 2025 16:48
@Guts Guts added the bug Something isn't working label Mar 26, 2025
@kannes
Copy link
Contributor

kannes commented Mar 28, 2025

Not a fan of this one! Those examples should be verbatim.

What exactly did they break?

@Guts
Copy link
Collaborator Author

Guts commented Mar 28, 2025

Okay sorry for the quick review & merge.

If we want to include examples in docstrings, I recommend to use the propre Sphinx syntax. Something like:

def foo():
    """summary.



    :example:

      .. highlight:: python
      .. code-block:: python

        import sys
        ...
    """

@kannes
Copy link
Contributor

kannes commented Mar 31, 2025

That would be super fancy and make sense especially when the documentation website is there. 👍

For now, would it be OK with you if we simply set those docstrings to raw strings (r""")? That makes pyqt5_to_pyqt6.py run without issues here.

@kannes
Copy link
Contributor

kannes commented Mar 31, 2025

I made a new ticket for this so that we can forget about it for now :)

-> #56

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants