Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Doc/Dev] Off-by-one errors for line numbers in documentation source #4038

Open
DanielYang59 opened this issue Sep 4, 2024 · 0 comments
Open

[Doc/Dev] Off-by-one errors for line numbers in documentation source #4038

DanielYang59 opened this issue Sep 4, 2024 · 0 comments
Labels
bug docs Documentation, examples, user guides needs investigation Needs further research to pinpoint cause of issue

Comments

@DanielYang59
Copy link
Contributor

DanielYang59 commented Sep 4, 2024 •
edited
Loading

The source code line numbers generated from:

pymatgen/docs/apidoc/conf.py

Line 360 in edcd465

filename = f"pymatgen/core/{rel_path}#L{line_start}-L{line_end}"

Seems to have off-by-one errors for some classes, but not all.

For example in https://pymatgen.org/pymatgen.alchemy.html, pointer to AbstractStructureFilter is correct, but off-by-one for ChargeBalanceFilter

image
@janosh janosh added bug docs Documentation, examples, user guides needs investigation Needs further research to pinpoint cause of issue labels Sep 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug docs Documentation, examples, user guides needs investigation Needs further research to pinpoint cause of issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@janosh @DanielYang59