Skip to content

Overhaul PlotDataItem documentation#3039

Merged
j9ac9k merged 7 commits intopyqtgraph:masterfrom
j9ac9k:docs-refurbish-plotdataitem
Jun 6, 2024
Merged

Overhaul PlotDataItem documentation#3039
j9ac9k merged 7 commits intopyqtgraph:masterfrom
j9ac9k:docs-refurbish-plotdataitem

Conversation

@j9ac9k
Copy link
Copy Markdown
Member

@j9ac9k j9ac9k commented Jun 1, 2024

  • Overhaul the PlotDataItem docs so that methods conform to numpydoc.
  • Add a variety of type-annotations

Unfortunately PlotDataItem is very dependent on *args and **kwargs, which makes doing the documentation and having it be verified rather difficult.

@j9ac9k j9ac9k force-pushed the docs-refurbish-plotdataitem branch 4 times, most recently from 62d5fa4 to aad937f Compare June 2, 2024 00:11
@j9ac9k j9ac9k force-pushed the docs-refurbish-plotdataitem branch from aad937f to 052b28d Compare June 2, 2024 16:17
sat: int
alpha: int

color_like: TypeAlias = (

Check notice

Code scanning / CodeQL

Unused global variable

The global variable 'color_like' is not used.
@j9ac9k j9ac9k force-pushed the docs-refurbish-plotdataitem branch 4 times, most recently from fcf430b to 43e756b Compare June 3, 2024 01:47
@j9ac9k j9ac9k force-pushed the docs-refurbish-plotdataitem branch 9 times, most recently from 38c35bb to 24e3856 Compare June 6, 2024 11:07
j9ac9k added 6 commits June 6, 2024 19:29
In addition, add some type annotations, fix typos, greatly expand on
the existing documentation, fix a variety of minor linter issues.
Since Qt signals can connect to other signals directly, we utilize that
mechanism instead of being dependent on the intermediate slots, whose
sole purpose is to emit another signal.
@j9ac9k j9ac9k force-pushed the docs-refurbish-plotdataitem branch from 24e3856 to 2c553e8 Compare June 6, 2024 23:29
@j9ac9k j9ac9k force-pushed the docs-refurbish-plotdataitem branch from 2c553e8 to 1ed0f1a Compare June 6, 2024 23:31
@j9ac9k j9ac9k merged commit 7be4b98 into pyqtgraph:master Jun 6, 2024
@j9ac9k j9ac9k deleted the docs-refurbish-plotdataitem branch June 6, 2024 23:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant