pyfar / pyfar/gallery

[DOC] Optional parameters and lists of posible inputs for parameters

Open
#119 1 comment 0 reactions 1 assignee View on GitHub

@hoyer-a is already working on this.

Since Oct 31, 2025.

documentation
Dominant language
Python
Stars
3
Forks
2
Avg merge
2d 3h
Merged PRs (30d)
3

Description

We're need to add a description of how to specify lists of possible inputs for function parameters ( such as only specific strings, etc.)

https://numpydoc.readthedocs.io/en/latest/format.html#parameters

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.