pyfar / pyfar/gallery

Add guidelines on plot label formats

Open
#133 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

in pyfar the axes are ususally called like Frequency in Hz, x in m, Phase in radancens...
in spharpy the labels are usually Phase (rad), x[m]

I would like to define it the contribution guidelines.

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 locating the repository's contribution guidelines and reviewing the existing plot-label examples described in the issue. Clarify which label format should be recommended for pyfar and spharpy, then document the agreed convention; done means contributors can find an explicit, consistent guideline for axis labels.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.