openstack/charms.openstack
Code Issues Proposed changes

Fixing typos in the README file

Browse Source 
Found some typos in the README file and this commit is to fix them.

Change-Id: Iba31cab4dbf8a8ff348dafcefdffca1ba244d7fe
This commit is contained in:
yazansalti
2022-04-21 23:33:48 +02:00
parent 13ef220ce3
commit 856a94cba0
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -73,7 +73,7 @@ to the charm author_, and can be signalled to `OpenStackCharm` in two ways.
case, there is no need to register multiple charms and provide a _chooser_ case, there is no need to register multiple charms and provide a _chooser_
to determine which class to use. to determine which class to use.
2. Write muliple `OpenStackCharm` derived classes which map to each difference 2. Write multiple `OpenStackCharm` derived classes which map to each difference
in charm functionality depending on the release, and register a _chooser_ in charm functionality depending on the release, and register a _chooser_
function using the `@register_os_release_selector` decorator. function using the `@register_os_release_selector` decorator.
@@ -123,7 +123,7 @@ of OpenStack.
## Using the relation adapter classes - OpenStackRelationAdapter ## Using the relation adapter classes - OpenStackRelationAdapter
The relation adapter classes adapt a reactive interface for use in the The relation adapter classes adapt a reactive interface for use in the
rendering functions. Their pricipal use is to provide an iterator of the rendering functions. Their principal use is to provide an iterator of the
attributes declared in the `assessors` attribute of the instance. attributes declared in the `assessors` attribute of the instance.
A reactive `BaseRelation` derived instance has an `auto_accessors` attribute A reactive `BaseRelation` derived instance has an `auto_accessors` attribute
@@ -183,7 +183,7 @@ overridden `__init__()` method.
## The `ConfigurationAdapter` ## The `ConfigurationAdapter`
The `ConfigurationAdapter` class simply provides _snapshot_ of the The `ConfigurationAdapter` class simply provides _snapshot_ of the
configuration opentions for the current charm, such that they can be accessed configuration options for the current charm, such that they can be accessed
as attributes of an instance of the class. e.g. rather than `config('vip')` as attributes of an instance of the class. e.g. rather than `config('vip')`
then user can use `c_adapter.vip`. then user can use `c_adapter.vip`.
@@ -216,7 +216,7 @@ class MyRelationAdapters(OpenStackRelationAdapters):
} }
``` ```
This enables custome relation adapters to be mapped to particular relations This enables custom relation adapters to be mapped to particular relations
such that custom functionality can be implemented for a particular reactive such that custom functionality can be implemented for a particular reactive
relationship. relationship.
@@ -269,7 +269,7 @@ statuses are supported:
relation is not yet _complete_ in that some data is missing still. relation is not yet _complete_ in that some data is missing still.
* blocked - a relation is not yet connected, or some other blocking * blocked - a relation is not yet connected, or some other blocking
condition. condition.
* paused - (Not yet availble) - the unit has been put into the paused state. * paused - (Not yet available) - the unit has been put into the paused state.
The default is for charms to support workload status, and the default The default is for charms to support workload status, and the default
installation method sets the status to maintenance with an install message. installation method sets the status to maintenance with an install message.