astropy / astropy/astropy

Linking type annotations to the glossary

Open
#18,010 2 comments 1 reaction 0 assignees View on GitHub
Docs typing units
Dominant language
Python
Stars
5.3k
Forks
2.2k
Avg merge
1d 18h
Merged PRs (30d)
74

Description

This should be linked to "unit-like" and vice versa. To the maximum extent that static typing allows, the two definitions should be the same.

_Originally posted by @nstarman in https://github.com/astropy/astropy/pull/18004#discussion_r2039880838_

Contributor guide

Open the contributing guide

Research direction

Locate the glossary entry for “unit-like” and the related type-annotation definitions in the documentation. Check how each term is currently defined and linked, then make the two definitions match as far as static typing permits and ensure each links to the other.

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.