Skip to content

Use normal Java conventions for file/package naming. - #438

Closed
marshallpierce wants to merge 2 commits into
sendgrid:mainfrom
marshallpierce:use-standard-java-file-locations
Closed

Use normal Java conventions for file/package naming.#438
marshallpierce wants to merge 2 commits into
sendgrid:mainfrom
marshallpierce:use-standard-java-file-locations

Conversation

@marshallpierce

Copy link
Copy Markdown

Checklist

  • I have made a material change to the repo (functionality, testing, spelling, grammar)
  • I have read the [Contribution Guide] and my PR follows them.
  • I updated my branch with the master branch.
  • I have added tests that prove my fix is effective or that my feature works
    • N/A, tests still pass
  • I have added necessary documentation about the functionality in the appropriate .md file
    • N/A, but now IntelliJ isn't yelling at me that the files are in the wrong place
  • I have added in line documentation to the code I modified
    • N/A, no logic modifications

Short description of what this PR does:

(Class com.foo.bar.Baz should be in com/foo/bar/Baz.java.) To avoid a breaking
change, I moved the files to match their existing packages, not the
other way around.

Also, moved ContentVerifier to be an inner static class, and added
trailing newlines to appease picky text editors.

Having non-standard file layout, or >1 top level classes per file, makes
incremental builds unreliable since build tools won't know where to look
for a class.

com.foo.bar.Baz should be in com/foo/bar/Baz.java.) To avoid a breaking
change, I moved the files to match their existing packages, not the
other way around.

Also, moved ContentVerifier to be an inner static class, and added
trailing newlines to appease picky text editors.

Having non-standard file layout, or >1 top level classes per file, makes
incremental builds unreliable since build tools won't know where to look
for a class.
@thinkingserious thinkingserious added the status: code review request requesting a community code review or review from Twilio label May 15, 2018
(with some editing) into the class javadoc because it would be confusing
to have a README.md in the main package that only referred to one class.
@thinkingserious

Copy link
Copy Markdown
Contributor

Thank you @marshallpierce! I've added this one to our backlog for review.

@RohanTalip

Copy link
Copy Markdown
Contributor

It looks like the travis-ci build for oraclejdk8 failed due to missing Javadoc:
https://travis-ci.org/sendgrid/sendgrid-java/jobs/379234069

@thinkingserious

Copy link
Copy Markdown
Contributor

Thanks for the heads up @RohanTalip!

@thinkingserious thinkingserious added type: community enhancement feature request not on Twilio's roadmap difficulty: medium fix is medium in difficulty labels Sep 28, 2018
@childish-sambino childish-sambino removed the type: community enhancement feature request not on Twilio's roadmap label Jul 20, 2020
@thinkingserious
thinkingserious changed the base branch from master to main July 28, 2020 14:33
@childish-sambino

Copy link
Copy Markdown
Contributor

Duplicate of #306

@childish-sambino childish-sambino marked this as a duplicate of #306 Oct 19, 2020
@childish-sambino childish-sambino added status: duplicate duplicate issue and removed difficulty: medium fix is medium in difficulty status: code review request requesting a community code review or review from Twilio labels Oct 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status: duplicate duplicate issue

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants