Skip to content

Conversation

thundergolfer
Copy link

Description

Adding missing docstrings for experimental/rules_python_external. Does not add new rules into Stardoc yet. That will be a subsequent pull request.

Plan 🛣

Our plan is in multiple steps:

  • bring in the repo to a subdirectory, preserving git history and contributors
  • clean up the code, remove mypy, get it functional in that subdirectory
  • add an example/integration test proving that it works
  • cut a patch release and get some users to test it out
  • communicate our deprecation plan to rules_python users
  • fill in any missing docstrings and include new rules in stardocPR is doing part one of this
  • BIG SWITCH: move the rules_python_external implementation to the root, make a legacy/ directory for current impl
  • cut a breaking release (a minor, since semver starting with 0. states that minors are breaking)
  • help users switch over
  • in a later breaking release, actually remove the old implementation

PR Checklist

Please check if your PR fulfills the following requirements:

  • Does not include precompiled binaries, eg. .par files. See CONTRIBUTING.md for info
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

Does this PR introduce a breaking change?

  • Yes
  • No

url = url,
sha256 = sha256,
type = "zip",
build_file_content = _GENERIC_WHEEL,
Copy link
Author

Choose a reason for hiding this comment

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

From running buildifier on file.

Copy link
Contributor

Choose a reason for hiding this comment

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

we should add a task to make that automated (I like to do it as a git pre-commit hook so you don't need to think about it)

""",
)

def pip_install(requirements, name = DEFAULT_REPOSITORY_NAME, **kwargs):
Copy link
Author

Choose a reason for hiding this comment

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

This is a really thin macro. Not doing much at all.

Copy link
Contributor

Choose a reason for hiding this comment

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

yeah in my PR to promote to public API, I use this as a spot to add the fetch of external repos like pypi__pip

""",
)

def pip_install(requirements, name = DEFAULT_REPOSITORY_NAME, **kwargs):
Copy link
Contributor

Choose a reason for hiding this comment

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

yeah in my PR to promote to public API, I use this as a spot to add the fetch of external repos like pypi__pip

url = url,
sha256 = sha256,
type = "zip",
build_file_content = _GENERIC_WHEEL,
Copy link
Contributor

Choose a reason for hiding this comment

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

we should add a task to make that automated (I like to do it as a git pre-commit hook so you don't need to think about it)

@alexeagle alexeagle merged commit e821ce9 into master Sep 20, 2020
@alexeagle alexeagle deleted the jonathon--rules_python_external-fill-missing-docstrings-sep2020 branch September 20, 2020 14:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants