scverse / scverse/fast-array-utils

Type aliases in docs should not get expanded

Open
#60 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

component: documentation
Dominant language
Python
Stars
15
Forks
5
Avg merge
10h 33m
Merged PRs (30d)
9

Description

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 reading the linked Sphinx issue (10541) to identify the affected documentation entry point and expected behavior. Then locate the corresponding docs or configuration in fast-array-utils; done means type aliases remain unexpanded in the generated documentation and the relevant documentation check passes.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.