docs: Verify/review config descriptions (#1960)

- Reviewed and modified descriptions.
- Added some minor formatting.
- Removed the "Key:" before every key name, seems redundant.
This commit is contained in:
Maria Shodunke
2025-04-09 17:49:11 +01:00
committed by GitHub
parent fcd891148b
commit 4a5fee7548
12 changed files with 785 additions and 605 deletions

View File

@@ -213,7 +213,10 @@ TEST_F(CliArgsTestsWithTmpFile, Parse_ConfigDescriptionFileContent)
auto const fileContent = buffer.str();
EXPECT_TRUE(fileContent.find("# Clio Config Description") != std::string::npos);
EXPECT_TRUE(fileContent.find("This file lists all Clio Configuration definitions in detail.") != std::string::npos);
EXPECT_TRUE(
fileContent.find("This document provides a list of all available Clio configuration properties in detail.") !=
std::string::npos
);
EXPECT_TRUE(fileContent.find("## Configuration Details") != std::string::npos);
// all keys that exist in clio config should be listed in config description file