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

Correct needs types in documentation #66

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

elupus
Copy link

@elupus elupus commented May 25, 2023

The documentation for needs type should match the default settings

elupus added 2 commits May 25, 2023 10:50
The documentation for needs type should match the default settings
Copy link
Member

@danwos danwos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should not change it, as for instance test-file is written like this in the rest of the documentation as well.

The only problem I see: test_suite and test_case should be test-suite and `test-case.

What do you think?

@elupus
Copy link
Author

elupus commented Jun 2, 2023

I'm fine with that. But the docs elsewhere refer to these using those names. For example in test_suite.rst: "test-suite creates a need of type Test-Suite and adds the following options automatically:". Those should be changed to lowercase too in that case to make it consistent.

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.

2 participants