8000 DOCS: Trait description is cluttering the sphinx documentation · Issue #441 · acoular/acoular · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

DOCS: Trait description is cluttering the sphinx documentation #441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
adku1173 opened this issue Feb 6, 2025 · 0 comments
Open

DOCS: Trait description is cluttering the sphinx documentation #441

adku1173 opened this issue Feb 6, 2025 · 0 comments
Labels
docs
Milestone
Documentation (WP4)

Comments

@adku1173
Copy link
Member
adku1173 commented Feb 6, 2025

Type of Problem

Unclear Information: The documentation is unclear.

Documentation Issue

I suggest unifying all trait and sphinx descriptions and relying only on the sphinx style of documentation instead. Otherwise, there is a lot of clutter and doubled documentation. For example see the docs of the MicGeom class:

Image

Proposal for Change

Better use

#: The aperture of the microphone array (read-only). 
#: I.e. the maximum distance between any two valid microphones. 
aperture = Property(depends_on=['pos'])
@adku1173 adku1173 added the docs label Feb 6, 2025
@adku1173 adku1173 added this to the Docs milestone Feb 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
Documentation (WP4)
Development

No branches or pull requests
1 participant
@adku1173
0