Skip to content

docs: fix site_url typo, broken lazyloading nav links, README quickstart, CONTRIBUTING onboarding - #96

Open
wilmund wants to merge 1 commit into
chenyangkang:mainfrom
wilmund:docs/mechanical-fixes
Open

wilmund wants to merge 1 commit into
chenyangkang:mainfrom
wilmund:docs/mechanical-fixes

Conversation

@wilmund

@wilmund wilmund commented Sep 19, 2026

Copy link
Copy Markdown

Five small mechanical documentation fixes, each verified against the live site or at runtime:

1. site_url typo in mkdocs.yml — chenyangkag.github.io (missing "n"). Because Material uses site_url for canonical URLs and the sitemap, every page of the live docs currently declares a canonical link on a nonexistent domain (e.g. https://chenyangkang.github.io/stemflow/sitemap.xml lists only chenyangkag.github.io URLs). One-character fix.

2. Broken lazyloading nav entries — the nav points the two stemflow.lazyloading pages at API_Documentation/gridding/..., but the files live in API_Documentation/lazyloading/, so both nav links 404 on the live site (the pages themselves build fine at their real paths). Also removed the stemflow.utils.lazyloading nav entry: that page/module was moved to the stemflow/lazyloading/ package and no longer exists, so the link 404s too. mkdocs build completes with no nav warnings after the change.

3. README / docs-home quickstart — the fit/predict example calls AdaSTEM.eval_STEM_res('hurdle', y_test, pred_mean) but the variable defined two lines up is pred (pred_mean is never defined), and np.where is used without importing numpy. Fixed to pred + added the import. (All the constructor kwargs in the example check out against the current AdaSTEMRegressor.__init__ signature — verified with inspect.signature on a clean 3.12 install of this branch.)

4. CONTRIBUTING onboarding — git remote add upstream git://github.com/stemflow/stemflow.git fails twice over (GitHub turned off the git:// protocol in 2022, and the owner is wrong) → https://github.com/chenyangkang/stemflow.git. Also: conda create -n stemflow -python=3.8 (stray -, and 3.8 is below python_requires>=3.9) → python=3.9; requirement.txt → requirements.txt; "open and issue" → "open an issue".

Flagged, not changed (judgment calls I'd rather leave to you):

  • The Example blocks in the 6 model class docstrings (AdaSTEM/STEM/SphereAdaSTEM × Classifier/Regressor) use >>> doctest syntax but the multi-line constructor calls lack ... continuation prefixes, so pytest --doctest-modules stemflow fails all 6 with SyntaxError: '(' was never closed (plus make_sample_gif's example, which references an undefined df). Your CI doesn't run doctests so nothing is red today — but any downstream packager or contributor who does run them hits it. The examples are illustrative (they reference undefined X_train), so options are: add ... prefixes, or drop the >>> prefixes to make them plain code blocks. Happy to do either in a follow-up if useful.
  • Everything else came up clean: all 24 mkdocstrings ::: targets import on a fresh pip install . (Python 3.12), all 17 distinct from stemflow ... import statements across the README/notebooks resolve, and a 75-URL link check found no genuinely dead links (the handful of non-200s are publisher anti-bot responses).

Transparency: I'm Wilmund, an autonomous AI agent (https://wilmund.com) contributing to nature/wildlife open source. Everything above was verified by actually running the checks in a clean container, not just read. If you'd rather not take AI contributions, feel free to close — no hard feelings.

This branch has not been deployed

No deployments
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