Warnings due to functions that aren't included in Python API being referenced from the documentation of other functions
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
When I run tox I get the following warnings:
FGEN:
session.py
Warning: "init" not found in function metadata. Typo? Generated code will be funky!
functions.rst
Warning: "init" not found in function metadata. Typo? Generated code will be funky!
DCPower
session.py
Warning: "ClearError" not found in function metadata. Typo? Generated code will be funky!
Warning: "MeasureMultiple" not found in function metadata. Typo? Generated code will be funky!
Warning: "ConfigureOutputFunction" not found in function metadata. Typo? Generated code will be funky!
Warning: "ConfigureCurrentLimit" not found in function metadata. Typo? Generated code will be funky!
Warning: "ConfigureOutputFunction" not found in function metadata. Typo? Generated code will be funky!
Warning: "ConfigureVoltageLimit" not found in function metadata. Typo? Generated code will be funky!
Warning: "ConfigureOutputEnabled" not found in function metadata. Typo? Generated code will be funky!
Warning: "ConfigureOutputEnabled" not found in function metadata. Typo? Generated code will be funky!
functions.rst
Warning: "MeasureMultiple" not found in function metadata. Typo? Generated code will be funky!
Warning: "ConfigureOutputFunction" not found in function metadata. Typo? Generated code will be funky!
Warning: "ConfigureCurrentLimit" not found in function metadata. Typo? Generated code will be funky!
Warning: "ConfigureOutputFunction" not found in function metadata. Typo? Generated code will be funky!
Warning: "ConfigureVoltageLimit" not found in function metadata. Typo? Generated code will be funky!
DMM
session.py
Warning: "ConfigureThermistorType" not found in function metadata. Typo? Generated code will be funky!
Warning: "ConfigureThermistorType" not found in function metadata. Typo? Generated code will be funky!
Warning: "ConfigureThermistorType" not found in function metadata. Typo? Generated code will be funky!
functions.rst
Warning: "ConfigureThermistorType" not found in function metadata. Typo? Generated code will be funky!
Warning: "ConfigureThermistorType" not found in function metadata. Typo? Generated code will be funky!
Warning: "ConfigureThermistorType" not found in function metadata. Typo? Generated code will be funky!
NI-SWITCH
session.py
Warning: "ClearError" not found in function metadata. Typo? Generated code will be funky!
Warning: "InitWithOptions" not found in function metadata. Typo? Generated code will be funky!
Warning: "init" not found in function metadata. Typo? Generated code will be funky!
Warning: "init" not found in function metadata. Typo? Generated code will be funky!
Warning: "InitWithOptions" not found in function metadata. Typo? Generated code will be funky!
functions.rst
Warning: "InitWithOptions" not found in function metadata. Typo? Generated code will be funky!
Warning: "init" not found in function metadata. Typo? Generated code will be funky!
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Run tox to reproduce the warnings, then inspect the referenced session.py and functions.rst files alongside the function metadata they use. Remove or correct references to functions not included in the Python API, and rerun tox until these warnings no longer appear.
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
- Mostly clear
- Newbie friendliness
- 35/100