Skip to content

Test quotes in the package description - #718

Merged
sjvrijn merged 1 commit into
NLeSC:mainfrom
simonvanlierde:fix/test-description-key
Oct 29, 2026
Merged

sjvrijn merged 1 commit into
NLeSC:mainfrom
simonvanlierde:fix/test-description-key

Conversation

@simonvanlierde

Copy link
Copy Markdown
Contributor

Checklist before requesting a review

  • I have read the contribution guidelines
  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas (nothing hard to follow)
  • I have made corresponding changes to the documentation (no docs change needed)
  • My changes generate no new warnings
  • 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
  • All user facing changes have been added to CHANGELOG.md (test-only, nothing user facing)

Type of change

  • Bug fix (non-breaking change which fixes an issue)

List of related issues or pull requests**

Refs:

  • none, I skipped the issue because this only touches a test

Describe the changes made in this pull request

Hi,

The two quote tests in tests/test_values.py set project_short_description, but the question is called package_short_description. So the description kept its default, and quotes in it were never tested.

  • Set package_short_description instead.
  • Check that the generated pyproject.toml parses and keeps the description as typed. With the old key these checks fail, because the description is "Short description of package".

The escaping itself works, so nothing changes for users.

Tests: pytest tests/test_values.py passes on Python 3.14.

Simon

The tests set project_short_description, but the question is
package_short_description, so the description kept its default and
quote escaping in it was never checked. Also assert that the
generated pyproject.toml keeps the description as typed.

@sjvrijn sjvrijn left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Good catch, thanks!

@sjvrijn
sjvrijn merged commit f183667 into NLeSC:main Oct 29, 2026
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants