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 pylint warnings of generate_how_to_cite.py #8264

Merged
merged 2 commits into from
Jun 12, 2024

Conversation

lrineau
Copy link
Member

@lrineau lrineau commented Jun 6, 2024

Summary of Changes

Without this PR, I have locally a lot of warnings with python-3.12:

[lrineau@fernand]~/Git/cgal-master% cmake build-doc  
-- /usr/bin/python3.12
/home/lrineau/Git/cgal-master/Documentation/doc/scripts/generate_how_to_cite.py:126: SyntaxWarning: invalid escape sequence '\c'
  title_r=title.replace("Kernel","%Kernel").replace("Interval","%Interval").replace("Matrix","%Matrix").replace("Kinetic","%Kinetic").replace("CGAL","\cgal").replace("Range","%Range")
/home/lrineau/Git/cgal-master/Documentation/doc/scripts/generate_how_to_cite.py:127: SyntaxWarning: invalid escape sequence '\c'
  authors=authors.replace("CGAL","\cgal")
/home/lrineau/Git/cgal-master/Documentation/doc/scripts/generate_how_to_cite.py:132: SyntaxWarning: invalid escape sequence '\c'
  <td class=\"bibtexitem\">\n "+authors+".\n "+title_r+".\n\
/home/lrineau/Git/cgal-master/Documentation/doc/scripts/generate_how_to_cite.py:202: SyntaxWarning: invalid escape sequence '\,'
  title=match.group(1).replace("\,",",")
/home/lrineau/Git/cgal-master/Documentation/doc/scripts/generate_how_to_cite.py:213: SyntaxWarning: invalid escape sequence '\c'
  assert len(bib)>0, "Did you forget a \cgalPkgBib{} in %r?" % filename
/home/lrineau/Git/cgal-master/Documentation/doc/scripts/generate_how_to_cite.py:214: SyntaxWarning: invalid escape sequence '\c'
  assert len(authors)>0, "Did you forget a \cgalPkgAuthors{} in %r?" % filename
/home/lrineau/Git/cgal-master/Documentation/doc/scripts/generate_how_to_cite.py:215: SyntaxWarning: invalid escape sequence '\c'
  assert len(anchor)>0, "Did you forget the anchor in \cgalPkgDescriptionBegin{} in %r?" % filename
-- Configuring done (0.1s)
-- Generating done (0.1s)
-- Build files have been written to: /home/lrineau/Git/cgal-master/build-doc

With this PR:

[lrineau@fernand]~/Git/cgal-master% cmake build-doc                              
-- /usr/bin/python3.12
-- Configuring done (0.1s)
-- Generating done (0.1s)
-- Build files have been written to: /home/lrineau/Git/cgal-master/build-doc

I have verified that the generated how_to_cite* files are identical.

Release Management

  • Affected package(s): Documentation/doc/scripts

@lrineau lrineau added this to the 6.0 milestone Jun 10, 2024
@lrineau lrineau added Doc Warnings For an issue about warnings, or a pull-request that fixes warnings labels Jun 10, 2024
@sloriot
Copy link
Member

sloriot commented Jun 12, 2024

Successfully tested in CGAL-6.0-Ic-264

@lrineau lrineau modified the milestones: 6.0, 6.0-beta Jun 12, 2024
@lrineau lrineau added rm only: ready for master For the release team only: that indicates that a PR is about to be merged in 'master' and removed Ready to be tested labels Jun 12, 2024
@lrineau lrineau merged commit e7d27c1 into CGAL:master Jun 12, 2024
8 checks passed
@lrineau lrineau removed the rm only: ready for master For the release team only: that indicates that a PR is about to be merged in 'master' label Jun 12, 2024
@lrineau lrineau deleted the linter-for-generate_how_to_cite.py branch June 12, 2024 08:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Doc Merged_in_6.0 Tested Warnings For an issue about warnings, or a pull-request that fixes warnings
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants