From 2181c847fcbf63a6d7f4242bf9f2088d4cf9bb51 Mon Sep 17 00:00:00 2001 From: anish-mudaraddi Date: Thu, 12 Dec 2024 16:15:28 +0000 Subject: [PATCH] DOC: formatting updates remove leading / on paths --- docs/developer_docs/ADDING_NEW_PRESETS.md | 10 +++++----- docs/developer_docs/ADDING_NEW_QUERIES.md | 6 +++--- docs/developer_docs/OVERVIEW.md | 2 +- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/developer_docs/ADDING_NEW_PRESETS.md b/docs/developer_docs/ADDING_NEW_PRESETS.md index d1b2e73..7455742 100644 --- a/docs/developer_docs/ADDING_NEW_PRESETS.md +++ b/docs/developer_docs/ADDING_NEW_PRESETS.md @@ -16,7 +16,7 @@ class QueryPresetsGeneric(QueryPresets): (Optional) Add alias mappings for the preset - see [Adding Aliases](ADDING_ALIASES.md) -## **2. Edit the corresponding handler class in `/openstackquery/handlers/client_side_handler_.py`.** +## **2. Edit the corresponding handler class in `openstackquery/handlers/client_side_handler_.py`.** Here you must: - add a 'client-side' filter function as a method @@ -135,15 +135,15 @@ group - you can add one like so: - it inherits from base class QueryPresets -2. Create new client side handler in `/openstackquery/handlers/client_side_handler_.py` - - it inherits from base class `ClientSideHandler` - `/openstackquery/handlers/client_side_handler.py`. +2. Create new client side handler in `openstackquery/handlers/client_side_handler_.py` + - it inherits from base class `ClientSideHandler` - `openstackquery/handlers/client_side_handler.py`. 3. Add your preset as a attribute in query_client_side_handlers dataclass - - located in `/openstackquery/structs/query_client_side_handlers.py` + - located in `openstackquery/structs/query_client_side_handlers.py` 4. Follow steps mentioned above to add new presets to the new preset group class you've created -5. Edit `QueryPresets` type declaration at the bottom of the file `/openstackquery/enums/query_presets.py` and add your new +5. Edit `QueryPresets` type declaration at the bottom of the file `openstackquery/enums/query_presets.py` and add your new preset class to it diff --git a/docs/developer_docs/ADDING_NEW_QUERIES.md b/docs/developer_docs/ADDING_NEW_QUERIES.md index f9a8071..eb48a9c 100644 --- a/docs/developer_docs/ADDING_NEW_QUERIES.md +++ b/docs/developer_docs/ADDING_NEW_QUERIES.md @@ -49,7 +49,7 @@ A new subclass of the `RunnerWrapper` class is required to store how to actually will also be the place where we can define extra parameters that can be used to fine-tune the query. To add a Runner Class: -1. Create a new file under `/openstackquery/runners/` called `_runner.py` replace `` with openstack resource name you want to query +1. Create a new file under `openstackquery/runners/` called `_runner.py` replace `` with openstack resource name you want to query 2. Create the `Runner` class definition - class must inherit from `RunnerWrapper` abstract base class and implement abstract methods. @@ -116,10 +116,10 @@ see `runners/server_runner.py` to see the implementation details. A new subclass of the `MappingInterface` class is required to store query mappings. To add a Mapping Class: -1. Create a new file under `/openstackquery/mappings/` called `_mapping.py` replace `` with openstack resource name you want to query +1. Create a new file under `openstackquery/mappings/` called `_mapping.py` replace `` with openstack resource name you want to query 2. Create the `Mapping` class definition - class must inherit from `MappingInterface` abstract base class and implement abstract methods. -3. Update the enum holding query types `/enums/query_types.py` and add a Enum mapping to this Mapping class. +3. Update the enum holding query types `openstackquery/enums/query_types.py` and add a Enum mapping to this Mapping class. 4. (Optional) Add alias mappings for the query type - see [Adding Aliases](ADDING_ALIASES.md) ### 3a. Set the Prop Enum class diff --git a/docs/developer_docs/OVERVIEW.md b/docs/developer_docs/OVERVIEW.md index 768b55d..c88865c 100644 --- a/docs/developer_docs/OVERVIEW.md +++ b/docs/developer_docs/OVERVIEW.md @@ -59,7 +59,7 @@ with openstack. The API must be unchanging - as a developer you will not need to interact with this file unless you are adding a new API method - e.g. adding a new way to output results -**NOTE: Deleting or Altering an API method requires approval from maintainers and a good reason since it may break +**NOTE: Deleting or altering an API method requires approval from maintainers and a good reason since it may break existing workflows**