Skip to content

Warn if a tab is present in the example's code (disable it with -warn…#244

Merged
eldipa merged 1 commit intomasterfrom
Issue-193-Handle-TABs-in-the-Examples
May 28, 2022
Merged

Warn if a tab is present in the example's code (disable it with -warn…#244
eldipa merged 1 commit intomasterfrom
Issue-193-Handle-TABs-in-the-Examples

Conversation

@eldipa
Copy link
Copy Markdown
Collaborator

@eldipa eldipa commented May 27, 2022

…-tab) (may break)

When there is a tab character in the example's code, emit a warning.
These tab characters may interfere with the interpreter/runner because
some of them execute an UI action (like autocomplete) on a tab key
stroke.

byexample configured its runners to not do such UI action however it is
not entirely possibly to dismiss the issue and because "if" it happens,
it is really hard to understand and debug it, it is better to warn about
it preventively.

This "may break" backward compatibility because it may annoy the user.
If needed, the user can set -warn-tab to disable the warning.

It is not expected to break real code as using a tab in the example's
code is unlikely and most probably a mistake.

Closes #193

…-tab) (may break)

When there is a tab character in the example's code, emit a warning.
These tab characters may interfere with the interpreter/runner because
some of them execute an UI action (like autocomplete) on a tab key
stroke.

byexample configured its runners to not do such UI action however it is
not entirely possibly to dismiss the issue and because "if" it happens,
it is really hard to understand and debug it, it is better to warn about
it preventively.

This "may break" backward compatibility because it may annoy the user.
If needed, the user can set -warn-tab to disable the warning.

It is not expected to break real code as using a tab in the example's
code is unlikely and most probably a mistake.
@eldipa eldipa added this to the 11.0.0 milestone May 27, 2022
@eldipa eldipa merged commit 1370c34 into master May 28, 2022
@eldipa eldipa deleted the Issue-193-Handle-TABs-in-the-Examples branch May 28, 2022 12:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Replace tabs by spaces to prevent autocompletion

1 participant