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

Modify DOXYGEN_WARNING_REGEX to support multiline warnings #136

Closed
wants to merge 3 commits into from

Conversation

lit-af
Copy link

@lit-af lit-af commented Jan 17, 2024

Should fix: #135

@Letme Letme requested a review from JasperCraeghs January 18, 2024 12:29
@JasperCraeghs
Copy link
Member

I don't see the option "Workflow(s) awaiting approval" to trigger the GitHub Actions. Do you know what's wrong, @Letme ?

https://docs.github.com/en/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks

@JasperCraeghs
Copy link
Member

JasperCraeghs commented Jan 20, 2024

Several unit tests fail. One of them is tests/test_doxygen.py:test_multiline

The input of this test case is:

This1 should not be treated as warning
testfile.c:6: warning: group test: ignoring title "Some test functions" that does not match old title "Some freaky test functions"
This should not be treated as warning2
testfile.c:8: warning: group test: ignoring title "Some test functions" that does not match old title "Some freaky test functions"

Instead of counting 2 warnings, the DoxygenChecker counts only 1 warning:

testfile.c:6: warning: group test: ignoring title "Some test functions" that does not match old title "Some freaky test functions"
This should not be treated as warning2
testfile.c:8: warning: group test: ignoring title "Some test functions" that does not match old title "Some freaky test functions"

A multiline warning indents all but its first line, doesn't it? I think that the regex must make use of this to make the distinction between a multiline warning and a singleline warning followed by some gibberish.

@lit-af
Copy link
Author

lit-af commented Jan 22, 2024

I look into it. You might be onto something with the indents on the multiline warnings.

Can you please tell me how to run the tests locally?

@JasperCraeghs
Copy link
Member

JasperCraeghs commented Jan 22, 2024

You can run the tests with tox in a virtual environment.

tox -e py310 when you have Python 3.10 or tox -e py311 when you have Python 3.11 etc.

Alternatively, use pytest after installing the package in editable mode:

pip3 install --editable .
pytest .

@Letme
Copy link
Member

Letme commented Mar 15, 2024

can you update with latest master just to see if the tests run now?

I think it would be good to move this forward a bit.

@lit-af
Copy link
Author

lit-af commented Mar 15, 2024

Sure. I'll try to find some time next week

@lit-af lit-af closed this Nov 15, 2024
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.

CodeQuality: Doxygen regex doesn't work for a warning that's on two lines
3 participants