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.

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

Turn off the JavadocComment #152

Merged
merged 9 commits into from
Jan 28, 2020
Merged

Turn off the JavadocComment #152

merged 9 commits into from
Jan 28, 2020

Conversation

dansanduleac
Copy link
Contributor

@dansanduleac dansanduleac commented Jan 27, 2020

Before this PR

The javadoc formatter is too opinionated for a lot of our repos and causes disruption while people manually clean up legacy docstrings that have markdown-style lists or carefully laid out code that should live inside a <pre> but doesn't.

After this PR

==COMMIT_MSG==
Turn off the javadoc formatter entirely.

We still indent the javadoc prefix to the corect column, but don't do any code reflowing or HTML tag correction anymore.
==COMMIT_MSG==

Possible downsides?

@changelog-app
Copy link

changelog-app bot commented Jan 27, 2020

Generate changelog in changelog/@unreleased

Type

  • Feature
  • Improvement
  • Fix
  • Break
  • Deprecation
  • Manual task
  • Migration

Description

Turn off the javadoc formatter entirely.

Check the box to generate changelog(s)

  • Generate changelog entry

@policy-bot policy-bot bot requested a review from iamdanfox January 27, 2020 17:30
@iamdanfox
Copy link
Contributor

Just some more tests to go green?

@bulldozer-bot bulldozer-bot bot merged commit 56c4824 into develop Jan 28, 2020
@bulldozer-bot bulldozer-bot bot deleted the ds/javadoc-off branch January 28, 2020 13:44
@svc-autorelease
Copy link
Collaborator

Released 0.3.16

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants