Skip to content

Pixeldataset docstrings public#403

Open
karlmoresco wants to merge 10 commits into
devfrom
pixeldataset-docstrings-public
Open

Pixeldataset docstrings public#403
karlmoresco wants to merge 10 commits into
devfrom
pixeldataset-docstrings-public

Conversation

@karlmoresco

Copy link
Copy Markdown

Description

  • Docs-generation implementation and configuration using Sphinx including adding of new dependencies
  • Docstrings in pixelator/src/pixelator/pna/pixeldataset that occur in the tutorials were reviewed and edited for better alignment with the Google style docstrings policies, and to better reflect the code behavior.

Fixes: subissues of #(PNA-2145) issue in Linear

Type of change

  • New feature (non-breaking change which adds functionality)

How Has This Been Tested?

No tests. Implementation affects only docstrings.

PR checklist:

  • This comment contains a description of changes (with reason).
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • If a new tool or package is included, I have updated dependencies in pyproject.toml and cited it properly [dev note: have updated dependencies but haven't cited]
  • I have checked my code and documentation and corrected any misspellings
  • I have documented any significant changes to the code in CHANGELOG.md

@karlmoresco karlmoresco requested a review from Aratz June 22, 2026 11:52
@github-actions

Copy link
Copy Markdown


Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


I have read the CLA Document and I hereby sign the CLA


Karl Moresco seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

@Aratz Aratz left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Great! I think this looks good to go. In the next PR, you could also add a github action to make sure the docs build successfully on each PR 👍

Comment thread docs/conf.py
Comment on lines +68 to +69
autoapi_own_page_level = "class"
autoapi_own_page_level = "function"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
autoapi_own_page_level = "class"
autoapi_own_page_level = "function"
autoapi_own_page_level = "function"

@Aratz

Aratz commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Also I think the CLA bot fails because you need to add your pixelgen email as a secondary email to your GitHub account in the GitHub settings.

@karlmoresco

Copy link
Copy Markdown
Author

All right! I'll look at the github action and the CLA bot failure, and get back tomorrow.

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.

2 participants