Skip to content
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

Jump to bottom

Indentation for compliant and non-compliant code examples is missing #1871

Closed
schalkms opened this issue Aug 30, 2019 · 0 comments · Fixed by #1876
Closed

Indentation for compliant and non-compliant code examples is missing #1871

schalkms opened this issue Aug 30, 2019 · 0 comments · Fixed by #1876
Assignees
@schalkms
Labels
bug formatting rules
Milestone
1.1.0

Comments

@schalkms
Copy link
Member

For some rules the compliant and non-compliant code examples use tabs instead of spaces to indent lines.
The tab character gets ignored when generating the corresponding .md file with the help of the detekt-generator.

Actual (with tabs)

https://arturbosch.github.io/detekt/style.html#equalsonsignatureline
https://arturbosch.github.io/detekt/style.html#explicititlambdaparameter

Expected (with spaces)

https://arturbosch.github.io/detekt/style.html#compliant-code-5
@schalkms schalkms self-assigned this Aug 30, 2019
@schalkms schalkms mentioned this issue Aug 31, 2019
Merged
3flex pushed a commit that referenced this issue Aug 31, 2019
@schalkms @3flex
Replace tabs with spaces in rule KDoc (#1876)
9070b81 
The parsed [KDocSection] element contains no tabs.
Therefore, the indentation gets removed when generating the Markdown
rule documentation out of the rules KDoc.
This PR fixes #1871.
@schalkms schalkms mentioned this issue Sep 1, 2019
Merged
sowmyav24 pushed a commit to sowmyav24/detekt that referenced this issue Sep 2, 2019
@schalkms @sowmyav24
Replace tabs with spaces in rule KDoc (detekt#1876)
819489d 
The parsed [KDocSection] element contains no tabs.
Therefore, the indentation gets removed when generating the Markdown
rule documentation out of the rules KDoc.
This PR fixes detekt#1871.
sowmyav24 pushed a commit to sowmyav24/detekt that referenced this issue Sep 2, 2019
@schalkms @sowmyav24
Replace tabs with spaces in rule KDoc (detekt#1876)
b3facb9 
The parsed [KDocSection] element contains no tabs.
Therefore, the indentation gets removed when generating the Markdown
rule documentation out of the rules KDoc.
This PR fixes detekt#1871.
sowmyav24 pushed a commit to sowmyav24/detekt that referenced this issue Sep 2, 2019
@schalkms @3flex
Replace tabs with spaces in rule KDoc (detekt#1876)
41f3fa8 
The parsed [KDocSection] element contains no tabs.
Therefore, the indentation gets removed when generating the Markdown
rule documentation out of the rules KDoc.
This PR fixes detekt#1871.
3flex pushed a commit that referenced this issue Sep 2, 2019
@schalkms @3flex
Add tabs check for KDoc in detekt-generator (#1884)
bd9fa7e 
* Add tabs check for KDoc in detekt-generator

This prevents the usage of tabs in KDoc to ensure correct indentation
when generating the Markdown rule documentation.
This relates to the issue described in #1871.

* Only use 1 tab in generator test snippet
sowmyav24 pushed a commit to sowmyav24/detekt that referenced this issue Sep 3, 2019
@schalkms @sowmyav24
Add tabs check for KDoc in detekt-generator (detekt#1884)
ec40778 
* Add tabs check for KDoc in detekt-generator

This prevents the usage of tabs in KDoc to ensure correct indentation
when generating the Markdown rule documentation.
This relates to the issue described in detekt#1871.

* Only use 1 tab in generator test snippet
@arturbosch arturbosch added this to the 1.0.2 milestone Sep 6, 2019
sowmyav24 pushed a commit to sowmyav24/detekt that referenced this issue Sep 17, 2019
@schalkms @sowmyav24
Replace tabs with spaces in rule KDoc (detekt#1876)
d2bfd13 
The parsed [KDocSection] element contains no tabs.
Therefore, the indentation gets removed when generating the Markdown
rule documentation out of the rules KDoc.
This PR fixes detekt#1871.
sowmyav24 pushed a commit to sowmyav24/detekt that referenced this issue Sep 17, 2019
@schalkms @sowmyav24
Add tabs check for KDoc in detekt-generator (detekt#1884)
b27c04b 
* Add tabs check for KDoc in detekt-generator

This prevents the usage of tabs in KDoc to ensure correct indentation
when generating the Markdown rule documentation.
This relates to the issue described in detekt#1871.

* Only use 1 tab in generator test snippet
@arturbosch arturbosch modified the milestones: 1.0.2, 1.1.0 Sep 17, 2019
smyachenkov pushed a commit to smyachenkov/detekt that referenced this issue Dec 9, 2019
@schalkms @smyachenkov
Replace tabs with spaces in rule KDoc (detekt#1876)
7574590 
The parsed [KDocSection] element contains no tabs.
Therefore, the indentation gets removed when generating the Markdown
rule documentation out of the rules KDoc.
This PR fixes detekt#1871.
smyachenkov pushed a commit to smyachenkov/detekt that referenced this issue Dec 9, 2019
@schalkms @smyachenkov
Add tabs check for KDoc in detekt-generator (detekt#1884)
2fd167b 
* Add tabs check for KDoc in detekt-generator

This prevents the usage of tabs in KDoc to ensure correct indentation
when generating the Markdown rule documentation.
This relates to the issue described in detekt#1871.

* Only use 1 tab in generator test snippet
smyachenkov pushed a commit to smyachenkov/detekt that referenced this issue Dec 9, 2019
@schalkms
Replace tabs with spaces in rule KDoc (detekt#1876)
168266b 
The parsed [KDocSection] element contains no tabs.
Therefore, the indentation gets removed when generating the Markdown
rule documentation out of the rules KDoc.
This PR fixes detekt#1871.
smyachenkov pushed a commit to smyachenkov/detekt that referenced this issue Dec 9, 2019
@schalkms
Add tabs check for KDoc in detekt-generator (detekt#1884)
3c7385e 
* Add tabs check for KDoc in detekt-generator

This prevents the usage of tabs in KDoc to ensure correct indentation
when generating the Markdown rule documentation.
This relates to the issue described in detekt#1871.

* Only use 1 tab in generator test snippet
@lock lock bot locked as resolved and limited conversation to collaborators Dec 26, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@schalkms schalkms

Labels
bug formatting rules
Projects
None yet
Milestone
1.1.0
Development

Successfully merging a pull request may close this issue.

Replace tabs with spaces in rule KDoc
2 participants
@arturbosch @schalkms