Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

The `display_name` parameter is misleadingly named

Aperta
#336 4 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
35/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
api

Direzione di ricerca

Leggi ni_measurementlink_service/measurement/service.py intorno alla riga 233 e ispeziona sia MeasurementService.configuration sia MeasurementService.output. Rinomina il parametro fuorviante mantenendo la vecchia parola chiave display_name come override deprecato e verifica che entrambi i metodi espongano il comportamento corretto e l'avviso.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement

Bug Report

The MeasurementService.configuration and MeasurementService.output methods have a display_name parameter, which is not the display name but rather the Protobuf field name. The display name is provided by the UI file, and is not required to match the Protobuf field name.

Repro or Code Sample

https://github.com/ni/measurementlink-python/blob/main/ni_measurementlink_service/measurement/service.py#L233

    def configuration(
        self,
        display_name: str,
        type: DataType,
        default_value: Any,
        *,
        instrument_type: str = "",
        enum_type: Optional[Type[Enum]] = None,
    ) -> Callable:

Expected Behavior

Parameter name correctly describes its function.

Current Behavior

Parameter name incorrectly describes its function.

Possible Solution

Rename parameter to name.

Add a keyword-only parameter with the old name (display_name) which defaults to None. If display_name is specified, override name and generate a deprecation warning.

Your Environment

  • OS & Device: Windows
  • ni-measurementlink-service version: 1.0 through 1.2.0-dev0
  • MeasurementLink version: N/A
  • Python version: N/A

AB#2457655

Lingua principale
Python
Stelle
21
Fork
20
Merge medio
1g 16h
PR unite (30g)
3

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ni/measurement-plugin-python

Tutte le issue di ni/measurement-plugin-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.