docs: Fix cross-references and kill Sphinx warnings #200
Conversation
This file contains 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
…r, . Added a slot and getter for query_id to BaseCursor. (Temporarily?) edited setup.cfg to ignore flake8 C901: function is too complex.
…and execute_many calls.
… logic for SET async_execution.
…tures. Edited callbacks and various tiny things in async test_cursor.py.
…y) on a unit test run.
…ync_execute() to remove async.
…uery. Changed AsyncExecutionUnavailableError to generically accept messages.
…rver_side_async_execute().
…han being sent in as an argument to execute(). Moved set parameter validation to its own function to deal with flake8 complaints re _do_exectute() being too complex.
… explain usefullness of that functionality.
…s.py and into conftest.py. Currently name not defined error. Maybe it's in the wrong conftest file?
…the docs to clarify the differences.
… in integration tests.
…the docs to clarify the differences.
… in integration tests.
…firebolt-db/firebolt-python-sdk into async_queries_add_cancel_status
…d. Also shortened a bunch of line lengths in the docs for easier diffing and better legibility when not using line wrapping.
|
Kudos, SonarCloud Quality Gate passed!
|
ericf-firebolt
changed the title
FireboltCorey
approved these changes
Aug 29, 2022
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.
There were some broken links in the docs, mostly to do with
autosectionlabeland bad cross-references. When I started to fix those I realized there were a lot of warnings being generated bysphinx-build. In addition to fixing the bad cross-references, I eliminated (almost) all of thesphinx-buildwarnings.Changes:
I shortened the line lengths to both make diffs easier and so that I wouldn't have to turn on line wrapping.
There are a lot of changes in the whitespace. I didn't like the look of the indenting in the code sections, so I changed the tabs to four spaces each.
There are still two issues with
autodocclaiming that it can find more than one reference for a cross-reference in some docstrings. There doesn't seem to be a nice way to fix that without changing the function signatures, so I'm ignoring it for now.This also includes an edit to
conf.pyto force document names to be prepended to section heads when creating automatic section labels. That allows us to useautosectionlabelbut eliminates the voluminous warnings about duplicated section labels. As an adjunct, it also made it easier for me to insure I was using the section in the correct file when cross-referencing.