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

Fixed escape characters format to handle warning due to misinterpretation of syntax #6585

Merged
merged 1 commit into from
Dec 16, 2024

Conversation

shachar-a
Copy link
Contributor

Fixes #
Added '' to strings containing ''. A single '' results in taking the following char as an escape character.
Existing code results with the following warnings:

/home/shachar/OpenSource/hpx/build3/docs/sphinx/conf.py:75: SyntaxWarning: invalid escape sequence '\p'
if "/// \page" in line:
/home/shachar/OpenSource/hpx/build3/docs/sphinx/conf.py:76: SyntaxWarning: invalid escape sequence '\p'
title = line.split("/// \page", 1)[-1].strip()
/home/shachar/OpenSource/hpx/build3/docs/sphinx/conf.py:77: SyntaxWarning: invalid escape sequence '\h'
elif "/// \headerfile" in line:
/home/shachar/OpenSource/hpx/build3/docs/sphinx/conf.py:78: SyntaxWarning: invalid escape sequence '\h'
header = line.split("/// \headerfile", 1)[-1].strip()

Proposed Changes

Add '' to single ''

Any background context you want to provide?

Checklist

Not all points below apply to all pull requests.

  • I have added a new feature and have added tests to go along with it.
  • I have fixed a bug and have added a regression test.
  • I have added a test using random numbers; I have made sure it uses a seed, and that random numbers generated are valid inputs for the tests.

@shachar-a shachar-a requested a review from hkaiser as a code owner December 10, 2024 09:08
@StellarBot
Copy link

Can one of the admins verify this patch?

@shachar-a
Copy link
Contributor Author

Fixes #1868

Copy link

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
-0.46%
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (e5746e6) 234528 200611 85.54%
Head commit (44a7a14) 191351 (-43177) 162807 (-37804) 85.08% (-0.46%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#6585) 0 0 ∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more

Copy link
Member

@hkaiser hkaiser left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@hkaiser
Copy link
Member

hkaiser commented Dec 10, 2024

The reported test failures on CIrcleCI are unrelated.

@shachar-a
Copy link
Contributor Author

Thanks,

the failing test blocks me from merging the changes.
How can I overcome this?

@hkaiser
Copy link
Member

hkaiser commented Dec 12, 2024

The failing tests are being resolved as we speak on a separate PR (#6582). Please give us a bit of time to merge this at which point everything should turn green for you as well.

@debx4
Copy link

debx4 commented Dec 14, 2024

I would love to work on this issue . And i would like to know is there some issue unfix I would like to work on that.

@shachar-a
Copy link
Contributor Author

Hi @debx4,
Thanks for suggesting to work on this. This task is done and under approval and merge process, so no further work is needed.
It was blocked due to some unrelated failing test which was handled by a separate PR (#6582)

@shachar-a
Copy link
Contributor Author

Hi @hkaiser ,
I see #6582 was merged.
I looked for a way to rerun the failing test, but couldn't find how that can be done. Perhaps I don't have the sufficient permissions?
Can you please help with rerun?
Thx

@Pansysk75
Copy link
Member

Hi @hkaiser , I see #6582 was merged. I looked for a way to rerun the failing test, but couldn't find how that can be done. Perhaps I don't have the sufficient permissions? Can you please help with rerun? Thx

Could you try rebasing your branch on the current master to get the latest changes? The CircleCI runners don't do that automatically. Thank you!

Copy link

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
-0.43%
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (74ff9db) 234528 200611 85.54%
Head commit (1ba43e1) 191366 (-43162) 162862 (-37749) 85.10% (-0.43%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#6585) 0 0 ∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more

@hkaiser hkaiser merged commit 3c0ebc8 into STEllAR-GROUP:master Dec 16, 2024
27 of 29 checks passed
@hkaiser
Copy link
Member

hkaiser commented Dec 16, 2024

@shachar-a Thank you for your contribution!

@shachar-a shachar-a deleted the fix_escape_char branch December 16, 2024 19:25
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.

5 participants