py4dstem / py4dstem/py4DSTEM

Adding python 3.10 documentation

Open
#727 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
279
Forks
177
PR merge metrics
No merged PRs in 30d

Description

Is your feature request related to a problem? Please describe.
Hello, first time py4dstem poster and fairly new 4DSTEM user.

Question for the devs: the dynamical simulation notebooks have been hugely helpful for me, both in terms of my research and also just learning about Bloch waves. However, the process.diffraction.crystal functions have docstrings that don't follow the normal numpy-style standards, which makes querying them difficult. See the following screenshot for an example:

Image

Note how several of the inputs get incorrectly shoved into the discriptions of args.

Will anyone care if I submit a PR cleaning these up? Not changing any calculations, just making all the type hints and parameter descriptions and whatnot pep-compliant, so they render properly in the documentation.

I wanted to check before starting because occasionally these atypical docstrings are intentionally designed a certain way to render properly in some third party solution.

Describe the solution you'd like
Someone to give me the thumbs up to change things

Describe alternatives you've considered
reading the raw code in the repo.

Additional context
N/A.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the docstrings for the process.diffraction.crystal functions and compare their current structure with NumPy-style documentation. Use the linked dynamical simulation notebook for context, then verify that parameter, type, and description sections render correctly in the documentation without changing calculations.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.