Code Monkey home page Code Monkey logo

Comments (7)

stof avatar stof commented on August 15, 2024

what is the use case for accessing comments ? to me, it would be weird to store comments in the AST being returned, given that comments are precisely meant to be ignored.

from gherkin.

bagintz avatar bagintz commented on August 15, 2024

Sorry, I should have mentioned that. I am attempting to write a documentation generator (mostly to create readable functional specs for stakeholders, testers and developers). There seem to be some based on Gherkin, but all windows based. I am using the behat gherkin library to parse the gherkin and for the documentation it would be helpful to have access to the comments.

from gherkin.

stof avatar stof commented on August 15, 2024

Well, couldn't you use the gherkin file itself for that ? It is meant to be readable by humans already.

from gherkin.

bagintz avatar bagintz commented on August 15, 2024

I think it would be fine for the testers and developers, but the concern is that it could be too detailed for the stakeholders. I definitely don't want to recreate a gherkin parser just to get comments hence this idea, but I just had the thought that since the behat/gherkin library returns the line numbers of each keyword, I could just write a separate class to pull out the comments.

from gherkin.

stof avatar stof commented on August 15, 2024

being too detailed for stakeholders depend of how you write your scenarios. I suggest you to look at the examples being used in http://everzet.com/post/99045129766/introducing-modelling-by-example

from gherkin.

bagintz avatar bagintz commented on August 15, 2024

Thanks I will take a look

from gherkin.

bagintz avatar bagintz commented on August 15, 2024

Great article by the way, thank you Stof for pointing me to it!!

from gherkin.

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.