Giter Site home page Giter Site logo

Comments (5)

elyezer avatar elyezer commented on June 25, 2024

@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.

from betelgeuse.

elyezer avatar elyezer commented on June 25, 2024

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

from betelgeuse.

sthirugn avatar sthirugn commented on June 25, 2024

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

from betelgeuse.

elyezer avatar elyezer commented on June 25, 2024

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

from betelgeuse.

elyezer avatar elyezer commented on June 25, 2024

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

from betelgeuse.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.