Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: no trailing comma in multi-line signatures by default #12975

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

TLouf
Copy link
Contributor

@TLouf TLouf commented Oct 5, 2024

Subject: no trailing comma in multi-line signatures by default

  • C and C++ domains will never feature a trailing comma as it'd correspond to incorrect syntax.
  • Python and JS get a new config value to optionally disable the trailing comma (for now enabled by default for backwards compatibility)

Feature or Bugfix

  • Bugfix

Relates

@picnixz
Copy link
Member

picnixz commented Oct 14, 2024

@TLouf Can you fix the conflicts and then request me for review please?

- C and C++ domains will never feature a trailing comma as it'd correspond to incorrect syntax.
- Python and JS get a new config value to optionally disable the trailing comma
@TLouf
Copy link
Contributor Author

TLouf commented Oct 19, 2024

@picnixz Done, I think this is ready for review.

@@ -967,6 +967,133 @@ def test_domain_py_python_maximum_signature_line_length_in_text(app):
assert expected_parameter_list_foo in content


@pytest.mark.sphinx(
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is not very elegant, but I don't think there is a way to parametrize a confoverride? If this can somehow be merged in the test above in a smart way, let me know though!

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

Successfully merging this pull request may close these issues.

3 participants