google / google/googletest

Documentation inconsistent on test names and underscores

Open
#3,960 0 comments 3 reactions 1 assignee Claimed by @derekmauro View on GitHub
bug
Dominant language
C++
Stars
39.5k
Forks
10.9k
Avg merge
6d 13h
Merged PRs (30d)
1

Description

The docs on generating custom names for parameterized tests says that underscores are not allowed

https://github.com/google/googletest/blob/b1e9b6323a17002b8359fef338c57bc0437caf57/docs/advanced.md?plain=1#L1184-L1186

but then in the example a few lines later, and underscore is used

https://github.com/google/googletest/blob/b1e9b6323a17002b8359fef338c57bc0437caf57/docs/advanced.md?plain=1#L1218-L1224

and in the documentation for the fourth parameter of `INSTANTIATE_TEST_SUITE_P `, it is explicitly allowed

https://github.com/google/googletest/blob/b1e9b6323a17002b8359fef338c57bc0437caf57/docs/reference/testing.md?plain=1#L113-L117

So which is it?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.