Skip to content

gh-880: Fix inconsistencies in the documentation rendering #889

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
Open
paddyroddy wants to merge 2 commits into
base: main
Choose a base branch
from
Open

gh-880: Fix inconsistencies in the documentation rendering #889

paddyroddy wants to merge 2 commits into from

Conversation

@paddyroddy
Copy link
Member

@paddyroddy paddyroddy commented Dec 11, 2025 •
edited
Loading

Description

The docs inconsistently use :func: etc. This PR aims to address that.

Fixes: #880

Changelog entry

Changed: Fixed some code references within the documentation

Checks

  • Is your code passing linting?
  • Is your code passing tests?
  • Have you added additional tests (if required)?
  • Have you modified/extended the documentation (if required)?
  • Have you added a one-liner changelog entry above (if required)?

@paddyroddy paddyroddy self-assigned this Dec 11, 2025
@paddyroddy paddyroddy added bug Something isn't working documentation Improvements or additions to documentation needs-2-reviewers Could be considered "controversial" so worth a second pair of eyes labels Dec 11, 2025
paddyroddy
paddyroddy commented Dec 11, 2025
View reviewed changes
glass/points.py
The bias model to apply. If a string, refers to a function in
the :mod:`~glass.points` module, e.g. ``'linear'`` for
:func:`glass.linear_bias()` or ``'glass.loglinear'`` for
:func:`glass.linear_bias` or ``'loglinear'`` for
Copy link
Member Author

@paddyroddy paddyroddy Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From reading the code, looks like it should never have been glass.loglinear @ntessore?

Copy link
Contributor

@connoraird connoraird Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If loglinear is needed than we should add :func: too?

Copy link
Member Author

@paddyroddy paddyroddy Dec 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no, loglinear and linear are strings

@paddyroddy paddyroddy mentioned this pull request Dec 11, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@connoraird connoraird connoraird approved these changes

@ntessore ntessore Awaiting requested review from ntessore

Assignees

@paddyroddy paddyroddy

Labels

bug Something isn't working documentation Improvements or additions to documentation needs-2-reviewers Could be considered "controversial" so worth a second pair of eyes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Consitent use of sphinx keywords in documentation

3 participants

@paddyroddy @connoraird