Fix broken documentation links in docstrings#1162
Merged
s3alfisc merged 5 commits intopy-econometrics:masterfrom Feb 4, 2026
Merged
Fix broken documentation links in docstrings#1162s3alfisc merged 5 commits intopy-econometrics:masterfrom
s3alfisc merged 5 commits intopy-econometrics:masterfrom
Conversation
- Fix relative paths in docstring links (remove /reference/ prefix) - Remove broken FixestMulti links (doc page doesn't exist) - Fix typo in Feols link (missing closing bracket) - Replace Greek letter β with 'beta' for Windows encoding compatibility Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Member
Hm when I built this locally, for some reason the links don't work / are not there 🤔 |
Codecov Report✅ All modified and coverable lines are covered by tests.
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 7 files with indirect coverage changes 🚀 New features to boost your workflow:
|
Member
|
@all-contributors please add @mdizadi for code |
Contributor
|
I could not determine your intention. Basic usage: @all-contributors please add @Someone for code, doc and infra For other usages see the documentation |
Member
|
@all-contributors please add @mdizadi for docs |
Contributor
|
I've put up a pull request to add @mdizadi! 🎉 |
Member
|
@all-contributors please add @mdizadi for docs |
Contributor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
/reference/prefix)FixestMultilinks (doc page doesn't exist)Feolslink (missing closing bracket)Details
The docstrings in
feols_.py,fepois_.py, andfeiv_.pycontained broken links that prevented the documentation from building correctly onWindows (due to encoding issues with the β character) and had incorrect paths for cross-references.
Test plan
pixi run -e docs docs-buildcompletes without errors.qmdfiles contain correct relative links