Skip to content

doc: fix autogenerated Python examples for required options without defaults #6987

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.

Sign up for GitHub

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

Closed
sakirr05 wants to merge 1 commit into from
Closed

doc: fix autogenerated Python examples for required options without defaults #6987

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 27 additions & 9 deletions lib/gis/parser_md_python.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,20 +327,38 @@ void print_python_example(FILE *file, const char *python_function,
if (opt->answer) {
value = G_store(opt->answer);
}
else if (opt->options && opt->type == TYPE_STRING) {
// Get example value from allowed values, but only for
// strings because numbers may have ranges and we don't
// want to print a range.
// Get allowed values as tokens.
else if (opt->options) {
// Get example value from allowed values.
// For strings, use the first value from comma-separated
// list. For numbers, only use if it's a discrete list (not
// a range). Get allowed values as tokens.
char **tokens;
char delm[2];
delm[0] = ',';
delm[1] = '\0';
tokens = G_tokenize(opt->options, delm);
// We are interested in the first allowed value.
if (tokens[0]) {
G_chop(tokens[0]);
value = G_store(tokens[0]);
// Check if we have at least one token and it's not empty
if (tokens[0] && tokens[0][0] != '\0') {
// For STRING types, always use first value from options
if (opt->type == TYPE_STRING) {
G_chop(tokens[0]);
value = G_store(tokens[0]);
}
// For INTEGER and DOUBLE types, only use if it's a
// discrete list (multiple tokens) and not a range (no
// '-' in first token)
else if (opt->type == TYPE_INTEGER ||
opt->type == TYPE_DOUBLE) {
// Check if there are multiple tokens (discrete
// list) and first token doesn't contain '-' (not a
// range)
int num_tokens = G_number_of_tokens(tokens);
if (num_tokens > 1 &&
strchr(tokens[0], '-') == NULL) {
G_chop(tokens[0]);
value = G_store(tokens[0]);
}
}
}
G_free_tokens(tokens);
}
Expand Down
Loading