ni / nimi-python

Python bindings for NI Modular Instrument drivers.
Other
111 stars 84 forks source link

Update the "About" and "Documentation" sections of individual READMEs #1990

Closed ni-jfitzger closed 1 year ago

ni-jfitzger commented 1 year ago

What does this Pull Request accomplish?

The individual READMEs, which can be see in both the repo and our PyPI module pages, contain information that is not relevant to the individual APIs, like nimi-python implmentation details.

This PR is intended to address that.

List issues fixed by this Pull Request below, if any.

What testing has been done?

Ran tox -e codegen

ni-jfitzger commented 1 year ago

I left the "Overall Project Status" section in. It still seems relevant, even for individual module pages. Let me know if you want it gone.

marcoskirsch commented 1 year ago

I left the "Overall Project Status" section in. It still seems relevant, even for individual module pages. Let me know if you want it gone.

Showing the status of the GitHub project makes sense to me.

ni-jfitzger commented 1 year ago

The merge from main was a clean merge, that doesn't affect this change, but I included it in case you saw something in the docs you didn't like that was already addressed in another change.