Skip to content

Docstring triggers python warnings in python 3.12.11 #32

@manulera

Description

@manulera

Hello @BjornFJohansson @louisabraham,

In python 3.12.11, loading the library triggers the following warning:

/Users/Manu/Documents/Projects/OpenCloning/OpenCloning_backend/.venv/lib/python3.12/site-packages/seguid/__init__.py:12: SyntaxWarning: invalid escape sequence '\ '
  **l**\ inear     **s**\ ingle     ``lsseguid()``
/Users/Manu/Documents/Projects/OpenCloning/OpenCloning_backend/.venv/lib/python3.12/site-packages/seguid/_chksum.py:70: SyntaxWarning: invalid escape sequence '\ '
  a string containing the **SE**\ quence **G**\ lobally **U**\ nique **ID**\ entifier (**SEGUID**\ ).

The reason is the usage of these unusual string patterns in the docstring of a couple of functions. Is there
a reason to use \ here? If not, I can make a PR to fix this and suppress the warning.

**SE**\ quence **G**\ lobally **U**\ nique **ID**\ entifier (**SEGUID**\ )

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions