docs: fix typos in docstrings and example descriptions - #713
Open
Avicennasis wants to merge 1 commit into
Open
Conversation
Corrects 17 documentation typos across docstrings and sphinx-gallery example headers. Documentation only; no functional or API changes. Signed-off-by: Léon Avic Simmons <Avicennasis@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes 17 documentation typos across docstrings and sphinx-gallery example headers. Documentation only — no functional or API changes, and no identifiers renamed.
Docstring fixes
src/ansys/fluent/visualization/graphics/graphics_objects.py:Pathlines.display()was documented as"""Display mesh graphics."""— a copy-paste fromMesh.display()directly above it. Now reads"""Display pathlines graphics.""".graphics_objects.py:from ansys.fluent.visualization import Graphics→ single space, in all four.. code-block:: pythonexamples in the file.plotter/pyvista/renderer.py,plotter/matplotlib/renderer.py:Matplot lib figure.→Matplotlib figure.plotter/pyvista/renderer.py,plotter/matplotlib/renderer.py,graphics/pyvista/renderer.py:Data consists the list of x and y values→Data consists of the list ...plotter/pyvista/renderer.py:pyvista chart 2D plotter→PyVista chart 2D plotter(x2), matching the spelling in this repo's owndoc/styles/config/vocabularies/ANSYS/accept.txt.graphics/graphics_windows.py,graphics/graphics_windows_manager.py,visualization_windows_manager.py:overlay : bool, Optional→bool, optional, matching numpydoc and thesession_id : str, optionalline directly above it in the same docstrings.Example-header fixes
examples/00-post_processing/post_processing_callbacks_and_animation.pyandpost_processing_plotter_apis_context_manager.py:**Key Featureswas missing its closing**, so the heading renders as literal asterisks instead of bold.post_processing_plotter_apis.pyalready has the correct**Key Features**.Additionally noticed
Six of the above were not in the set I originally set out to fix; I included them because each is the same string in a file that would have looked arbitrary to leave behind:
Matplot libandData consists theinplotter/matplotlib/renderer.pyData consists theingraphics/pyvista/renderer.pyoverlay : bool, Optionalingraphics/graphics_windows_manager.py**Key Featuresinpost_processing_plotter_apis_context_manager.pyimport Graphicsoccurrences ingraphics_objects.pyHappy to split any of these out if you would rather keep the change narrower.
Deliberately not changed
Pyvista→PyVistaappears 14 more times across fiveexamples/headers. Youraccept.txtsaysPyVista, so these look wrong too, but sweeping them felt out of proportion for a typo PR — happy to add them on request.if self._single_window and val == False:inconfig.py. Flagged to me as non-PEP8, but it is executable code rather than documentation, so I left it alone.Verification
Each replacement was applied byte-wise with a uniqueness assertion and a file-length delta check, so the diff is exactly 17 changed lines with no line-ending churn. All nine touched files byte-compile, and no edited line exceeds the
max-line-length = 88in.flake8.