mindsdb icon indicating copy to clipboard operation
mindsdb copied to clipboard

Change formatting of examples in the doc

Open Wayrion opened this issue 3 years ago • 3 comments

Fixes #

Please describe what changes you made, in as much detail as possible

Change formatting fixing #2929 mindsdb

Wayrion avatar Oct 13 '22 11:10 Wayrion

Sorry its hard to preview this from here, this will make all those keywords as italic right?

ZoranPandovski avatar Oct 13 '22 15:10 ZoranPandovski

Yep

Wayrion avatar Oct 13 '22 15:10 Wayrion

@Artemis6969 The italics font is used for the names that are a placeholder for a real name. Here are some examples.

Example 1: Below statement...

CREATE PREDICTOR mindsdb.[predictor_name]
FROM [integration_name]
    (SELECT [column_name, ...] FROM [table_name])
PREDICT [target_column]

...should change into:

CREATE PREDICTOR mindsdb._predictor_name_
FROM _integration_name_
    (SELECT _column_name_, _..._ FROM _table_name_)
PREDICT _target_column_;

Example 2: Below statement...

SELECT *
FROM mindsdb.predictors
WHERE name='[predictor_name]';

...should change into:

SELECT *
FROM mindsdb.predictors
WHERE name='_predictor_name_';

martyna-mindsdb avatar Oct 20 '22 19:10 martyna-mindsdb