Skip to content

Conversation

Copy link

Copilot AI commented Dec 23, 2025

Description

Corrects two documentation errors in docs/api/cassandra/protocol.rst:

  • Sphinx reference syntax: Removed extra colon from ::meth::meth: in the reference to .Session.execute_async
  • Class name typo: Fixed NumpyProtocolHanderNumpyProtocolHandler (missing 'l')

Pre-review checklist

  • I have split my patch into logically separate commits.
  • All commit messages clearly explain what they change and why.
  • I added relevant tests for new features and bug fixes.
  • All commits compile, pass static checks and pass test.
  • PR description sums up the changes and reasons why they should be introduced.
  • I have provided docstrings for the public items that I want to introduce.
  • I have adjusted the documentation in ./docs/source/.
Original prompt
Please apply the following diffs and create a pull request.
Once the PR is ready, give it a title based on the messages of the fixes being applied.

[{"message":"There is an extra colon in the Sphinx reference '::meth:`.Session.execute_async`'. It should be ':meth:`.Session.execute_async`'.","fixFiles":[{"filePath":"docs/api/cassandra/protocol.rst","diff":"diff --git a/docs/api/cassandra/protocol.rst b/docs/api/cassandra/protocol.rst\n--- a/docs/api/cassandra/protocol.rst\n+++ b/docs/api/cassandra/protocol.rst\n@@ -16,7 +16,7 @@\n By default these are ignored by the server. They can be useful for servers implementing\n a custom QueryHandler.\n \n-See :meth:`.Session.execute`, ::meth:`.Session.execute_async`, :attr:`.ResponseFuture.custom_payload`.\n+See :meth:`.Session.execute`, :meth:`.Session.execute_async`, :attr:`.ResponseFuture.custom_payload`.\n \n .. autoclass:: _ProtocolHandler\n \n"}]},{"message":"The class name 'NumpyProtocolHander' is misspelled. It should be 'NumpyProtocolHandler' (missing 'l').","fixFiles":[{"filePath":"docs/api/cassandra/protocol.rst","diff":"diff --git a/docs/api/cassandra/protocol.rst b/docs/api/cassandra/protocol.rst\n--- a/docs/api/cassandra/protocol.rst\n+++ b/docs/api/cassandra/protocol.rst\n@@ -53,5 +53,5 @@\n - LazyProtocolHandler: near drop-in replacement for the above, except that it returns an iterator over rows,\n   lazily decoded into the default row format (this is more efficient since all decoded results are not materialized at once)\n \n-- NumpyProtocolHander: deserializes results directly into NumPy arrays. This facilitates efficient integration with\n+- NumpyProtocolHandler: deserializes results directly into NumPy arrays. This facilitates efficient integration with\n   analysis toolkits such as Pandas.\n"}]}]

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

- Fix extra colon in Sphinx reference (::meth: -> :meth:)
- Fix typo in class name (NumpyProtocolHander -> NumpyProtocolHandler)

Co-authored-by: mykaul <4655593+mykaul@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix typos in Sphinx documentation references Fix Sphinx reference syntax and class name typo in protocol.rst Dec 23, 2025
Copilot AI requested a review from mykaul December 23, 2025 09:37
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.

2 participants