Skip to content

Use verbatim text in config file examples #56

@kannes

Description

@kannes

#51 added extraneous backslashes to config file structure examples which makes them incorrect.

This was required to get inspection tools like pyqt5_to_pyqt6.py to not fail on:

./profile_manager/handlers/expressions.py:6: SyntaxWarning: invalid escape sequence '\e'
./profile_manager/handlers/customization.py:7: SyntaxWarning: invalid escape sequence '\A'

A workaround would be marking the docstrings as raw strings (r""").

@Guts alternatively suggested switching to Sphinx style docstring structure in #51 (comment) although I am actually not sure if that would really change how pyqt5_to_pyqt6.py interprets the strings?

An alternative solution would be to move the examples into separate documentation (once #52 is merged). The docstrings should still clearly say what the functions do, but maybe having the example contents of config files there was not really a good idea in the first place.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions