-
Notifications
You must be signed in to change notification settings - Fork 6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Enhance code quality #6
Enhance code quality #6
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #6 +/- ##
==========================================
+ Coverage 89.07% 89.96% +0.89%
==========================================
Files 24 24
Lines 842 947 +105
==========================================
+ Hits 750 852 +102
- Misses 92 95 +3 ☔ View full report in Codecov by Sentry. |
4982384
to
ec787e7
Compare
- Fix typos. - Fix broken links. - Improve readability.
Update conf.py with functionalities to specify which special members have to be kept in the documentation.
The name of the `pipelines` module was mistakenly spelled as `piplines`.
There were several places that we had used `mock data` to refer to data generated for testing purposes. This was misleading as we are actually generating the data and the API calls are not mocked. Example `mock_database` is renamed to `test_database`.
As a result, `test_utils` and the `queries` route handler have been also updated.
03506ae
to
4f426ad
Compare
4f426ad
to
76fe40e
Compare
The new version of FastAPI recommends using `Annotated` for queries. This also resolves the issue with ruff complaining about `Query(None)`.
2c8a672
to
a4298f5
Compare
This led to the removal of some redundant type checks.
The bug had to do with multiple deletion in the recorder. The log message was added to the auto exception handler.
Add two auxiliary methods which simplify the implementation of the main method.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just some minor comments, otherwise looks good!
The function is named `make_query_string`
The old name of the function was `parse_config_yaml_file`. The function now accepts a number of different types for the input arg `file`.
This logs and catches unhandled exceptions.
- Remove type hint for `file`. - Amend docstring. - Remove explicit exception handling for parsing and reading the file.
As a result, the signature of `run_server()` and `api_server_process_context()` have been changed. They now only accept a `config` object of type `AppConfig`.
bf6a73d
to
506f122
Compare
The dependencies are now brought after the first main dependent function that uses them.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
This PR is about
conf.py
to exclude unused special members.