Fix code for generating config files #4074
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Can you please add it also to C-API? |
I added corresponding functions to the C API. |
Do we really need any new API function not only for C++ but also for C? |
|
Why C and C++ API should not be synchronized (providing the same features)? |
|
Each additional API creates some costs (implementation, maintenance, code size). And is there still a need for a C API? Maybe we should even consider dropping the whole C API in a future version 6. If a C API for a new function is really missing it can be added any time later. |
|
IMO costs are minimal for CAPI. I see no benefit in removing it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #3943, see that issue for a full explanation and previous discussion on this issue.
In short, the function
ParamUtils::PrintParamspreviously created a machine-readable config file with parameter names and values. It was then edited to add human-readable descriptions to each of the parameters. While this change undoubtedly made the results easier for users to interpret, the resulting files no longer functioned properly as config files. This (1) broke the parts of the code that assumedParamUtils::PrintParamscreated machine-readable config files and (2) meant there was no longer an API function for creating machine-readable config files using the current settings.This PR fixes both issues:
ParamUtils::PrintParamsto specify whether descriptions of parameters should be printedParamUtils::PrintParamsis inarguably being used with the intent of creating a machine-readable config file, the parameter is set totrueDumpVariableshas been added, which creates config files (the old behavior ofPrintVariables)