Skip to content

docs: enforce that api docs are up-to-date - #540

Merged
alexeagle merged 2 commits into
bazel-contrib:mainfrom
alexeagle:docs
Oct 12, 2021
Merged

docs: enforce that api docs are up-to-date#540
alexeagle merged 2 commits into
bazel-contrib:mainfrom
alexeagle:docs

Conversation

@alexeagle

Copy link
Copy Markdown
Contributor

Previously we just suggested you run a shell script to update, but there was no clue when that was needed in a PR

@hrfuller hrfuller 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 thanks!

@thundergolfer

thundergolfer commented Oct 12, 2021

Copy link
Copy Markdown

Merging main has created a CI error.

It looks like the failing test involves installing futures >= 3.1 which is a backport package and does not work on Python 3. If this CI error has just shown up now, maybe the CI instance's default Python has changed?

Edit: Looks like example .egg should be regen'd, because it's got some dead code.

    # Note: this .egg file can be regenerated using zipper:
    # $ third_party/ijar/zipper Cc \
    #   examples/py_import/helloworld.egg \
    #   examples/py_import/helloworld.py=examples/legacy_pip_import/helloworld/helloworld.py \
    #   examples/__init__.py= \
    #   examples/py_import/__init__.py=

@alexeagle

Copy link
Copy Markdown
Contributor Author

I don't understand if the main branch is green, how the futures problem is just happening now. I'll try a rebase just to roll the dice

Previously we just suggested you run a shell script to update, but there was no clue when that was needed in a PR
@alexeagle
alexeagle merged commit 562ffc7 into bazel-contrib:main Oct 12, 2021
@alexeagle
alexeagle deleted the docs branch October 12, 2021 23:47
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