Skip to content

Centralise the canonical import paths and more package docs - #130

Merged
enocom merged 1 commit into
agones-dev:masterfrom
markmandel:bug/godoc-imports
Mar 8, 2018
Merged

enocom merged 1 commit into
agones-dev:masterfrom
markmandel:bug/godoc-imports

Conversation

@markmandel

@markmandel markmandel commented Mar 6, 2018 •

Copy link
Copy Markdown
Member

Put the canonical import path into the main directory, to centralise it, and make sure it's applied across everything.

As a side effect of this work, also added some more package docs.

@markmandel markmandel added kind/bug These are bugs. kind/documentation Documentation for Agones labels Mar 6, 2018
@markmandel markmandel added this to the 0.1 milestone Mar 6, 2018
@markmandel
markmandel force-pushed the bug/godoc-imports branch 4 times, most recently from 3300f62 to 5e4f24b Compare March 6, 2018 19:29
@markmandel

Copy link
Copy Markdown
Member Author

/cc @enocom as I know you had opinions 😄

@markmandel markmandel removed the kind/bug These are bugs. label Mar 6, 2018
@markmandel

Copy link
Copy Markdown
Member Author

.. or maybe it actually makes more sense to drop this into 0.2 and play the safe game. WDYT?

@enocom

enocom commented Mar 7, 2018

Copy link
Copy Markdown
Contributor

@markmandel Yeah. Definitely a nice to have. It's probably just a matter of finding the convention and following it.

@markmandel

Copy link
Copy Markdown
Member Author

SGTM. Moving to 0.2, and this PR can be a thread on how we want to have a convention on this.

@markmandel markmandel modified the milestones: 0.1, 0.2 Mar 7, 2018
@enocom

enocom commented Mar 7, 2018 •

Copy link
Copy Markdown
Contributor

Take a look at google-cloud-go. The top level cloud.go file specifies an import restriction. That same restriction appears nowhere else in subpackages.

If that's any guide, then the single restriction in the version.go file is enough and this PR may be closed without merging.

@markmandel

Copy link
Copy Markdown
Member Author

From going from your above code - maybe there should be an import.go (or a doc.go) at the top level of this repository (rather than in pkg) - which would cover pkg, cmd and sdks/go.

That would seem to make more sense?

@markmandel markmandel added the kind/cleanup Refactoring code, fixing up documentation, etc label Mar 7, 2018
@enocom

enocom commented Mar 7, 2018

Copy link
Copy Markdown
Contributor

Putting the restriction in a doc.go file is perfect. Great idea!

@agones-bot

Copy link
Copy Markdown
Collaborator

Build Succeeded 👏

Build Id: 7b8b3817-33e6-4e6e-837c-0450f3e63328

The following development artifacts have been built, and will exist for the next 30 days:

Put the canonical import path into the main directory, to
centralise it, and make sure it's applied across everything.

As a side effect of this work, also added some more package docs.
@markmandel markmandel changed the title More canonical import paths and package docs Centralise the canonical import paths and more package docs Mar 8, 2018
@markmandel

Copy link
Copy Markdown
Member Author

Done! PTAL.

@markmandel
markmandel requested a review from enocom March 8, 2018 20:42
@agones-bot

Copy link
Copy Markdown
Collaborator

Build Succeeded 👏

Build Id: 3b6ce222-b669-4781-bb02-0734b0f43c8e

The following development artifacts have been built, and will exist for the next 30 days:

@enocom enocom left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@enocom
enocom merged commit a5f2b97 into agones-dev:master Mar 8, 2018
@markmandel
markmandel deleted the bug/godoc-imports branch March 8, 2018 21:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/cleanup Refactoring code, fixing up documentation, etc kind/documentation Documentation for Agones

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants