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

Warning message is also added in that particular section along with text. #52

Closed
madhuriupadhye opened this issue Jul 7, 2016 · 5 comments

Comments

@madhuriupadhye
Copy link

Suppose after running the .py file contains some warning like (WARNING/2) Enumerated list ends without a blank line; unexpected unindent for steps section then it was added in steps section of polarion with steps.
screenshot from 2016-07-07 12 10 26

@sthirugn sthirugn added the bug label Jul 7, 2016
@elyezer
Copy link
Collaborator

elyezer commented Jul 7, 2016

@madhuriupadhye thank you for creating the issue. Make sure you have the valid Restructured Text before running Betelgeuse. I think it is able to remove that warning, but having that makes us aware that our RST formatting is not good.

I've been thinking on a way to fix it, but I have not decided what is best, skip the test case if the parse can't be successfully completed (which is bad because that is not a blocker for creating the test case), just remove the warning and have poorly formatted information on Polarion (by removing the warning you will end up with a list of 3 elements and one paragraph starting with the literal string 4. on your example). With that said I don't see any other option and I think is better to have the warning so we can update the docstring to make it able to be parsed properly.

@elyezer elyezer removed the bug label Jul 7, 2016
@elyezer
Copy link
Collaborator

elyezer commented Jul 7, 2016

Removing the bug label since this is not a Betelgeuse bug but a feature to notify when bad RST docstring is received.

@sthirugn
Copy link
Contributor

sthirugn commented Jul 7, 2016

@madhuriupadhye can you paste the test docstring test case which created this error?

@elyezer
Copy link
Collaborator

elyezer commented Jul 7, 2016

The issue is mostly like because the second line of item 4 was not indented, it should be like this:

4. first line
line continuation

While it should be something like:

4. first line
   line continuation

@elyezer
Copy link
Collaborator

elyezer commented Nov 8, 2019

I can't reproduce this with the latest version of Betelgeuse.

@elyezer elyezer closed this as completed Nov 8, 2019
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

No branches or pull requests

3 participants