Skip to content

Fix contributor docs - #39

Merged
mrtzh merged 2 commits into
masterfrom
fix-contributor-docs
Aug 8, 2026
Merged

mrtzh merged 2 commits into
masterfrom
fix-contributor-docs

Conversation

@mrtzh

@mrtzh mrtzh commented Aug 8, 2026

Copy link
Copy Markdown
Member

Follow-up to #38. Three small fixes, no behaviour change.

  • Drop PYTHONPATH: tests/gym_tests from CI. It was redundant and its
    comment claimed otherwise: tests/gym_tests/ has no __init__.py, so pytest
    prepends it to sys.path itself. Verified by running the CI command with
    PYTHONPATH unset — 92 tests collected and passing. A green test job here is
    the confirmation on both platforms.
  • Document linting in CONTRIBUTING. Make WhyNot run on current Python and dependencies #38 added a lint job, but CONTRIBUTING
    never mentioned it, so following it exactly gave a clean local run and a red
    PR on formatting.
  • Point this repo's links at socialfoundations. README, docs and two
    notebooks still said zykls. GitHub redirects transfers so they resolved,
    but they misreported where the project lives. This includes the CI badge,
    which Make WhyNot run on current Python and dependencies #38 added pointing at zykls and which therefore rendered nothing.

github.com/zykls/whynot_estimators is deliberately left alone in five
places — that is a separate project which has not moved
(socialfoundations/whynot_estimators does not exist), so rewriting it would
break working links. The replacement requires the next character to be / or
. rather than matching the repository name as a prefix.

MH and others added 2 commits August 8, 2026 12:49
The CI test step carried PYTHONPATH=tests/gym_tests with a comment claiming
gym_tests needs it to import spec_list. It does not: that directory has no
__init__.py, so pytest prepends it to sys.path itself. Verified by running the
CI command with PYTHONPATH unset, which collects and passes all 92 tests. The
setting was redundant and the comment asserted something untrue.

CONTRIBUTING did not mention linting, which CI now enforces through lint.sh.
Anyone following it exactly got a green local run and a red pull request on
formatting. Add the lint step and say which tools run, rather than the previous
generic reference to PEP8.

Co-Authored-By: Claude <noreply@anthropic.com>
The repository moved from the zykls organisation, but the README, docs and two
notebooks still linked to zykls. GitHub redirects transferred repositories, so
the links resolved, but they misreport where the project lives.

Left github.com/zykls/whynot_estimators alone in five places. That is a
separate project which has not moved: socialfoundations/whynot_estimators does
not exist, so rewriting those would have broken working links. The match
therefore requires the next character to be / or . rather than matching the
repository name as a prefix.

Includes the CI badge, which this branch's predecessor added pointing at zykls
and which consequently rendered nothing.

Co-Authored-By: Claude <noreply@anthropic.com>
@mrtzh
mrtzh merged commit a47553b into master Aug 8, 2026
7 checks passed
@mrtzh
mrtzh deleted the fix-contributor-docs branch August 11, 2026 11:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant