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

Is there a way to render text just for context in the feature file? #1145

Closed
patrickmead opened this issue Oct 23, 2023 · 2 comments
Closed
Labels

Comments

@patrickmead
Copy link

There are times when we want to provide context that isn't actionable but it should be visible to all. Consequently, given statements, background descriptions, and comments aren't the appropriate mechanisms for communicating this type of information.

This information typically would be stored in a Word/Google document, Confluence, etc. I would like to include it in the feature file to keep the context close to the specifications. Obviously we don't want the feature files to be unreadable so we might provide summaries and links if there is a large amount of content.

I was pretty familiar with tools like JBehave and Serenity years ago; I thought that Serenity had this capability. I haven't used them in years so I might not be remembering the feature sets correctly. I've since switched to python development thus my interest in behave.

Thank you.

@jenisys
Copy link
Member

jenisys commented Oct 23, 2023

I am still not quite sure what you are looking for.
But I assume you are looking for descriptions:

  • A description is basically text between a feature/rule/scenario title and its body.
  • A description can be 0 .. N lines of text (meaning: a description is optional)
  • A description cannot start with a keyword in a description line.

EXAMPLE:

SEE ALSO:

@patrickmead
Copy link
Author

Thank you so much for the quick reply. description is exactly what I needed.

I missed it originally but I certainly see description in the documentation now.

@jenisys jenisys closed this as completed Dec 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants