Skip to content

Commit

Permalink
Typo fix in docs and comments: compatability -> compatibility
Browse files Browse the repository at this point in the history
  • Loading branch information
odelalleau committed Jul 23, 2023
1 parent 93f7ac6 commit 74cbabc
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion hydra/version.py
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ def setbase(ver: Any) -> None:
message=dedent(
f"""
The version_base parameter is not specified.
Please specify a compatability version level, or None.
Please specify a compatibility version level, or None.
Will assume defaults for version {__compat_version__}"""
),
stacklevel=3,
Expand Down
2 changes: 1 addition & 1 deletion tests/test_hydra.py
Original file line number Diff line number Diff line change
Expand Up @@ -1480,7 +1480,7 @@ def test_hydra_main_without_config_path(tmpdir: Path) -> None:
f"""
.*my_app.py:7: UserWarning:
The version_base parameter is not specified.
Please specify a compatability version level, or None.
Please specify a compatibility version level, or None.
Will assume defaults for version {version.__compat_version__}
@hydra.main()
.*my_app.py:7: UserWarning:
Expand Down
8 changes: 4 additions & 4 deletions website/docs/advanced/compose_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ All 3 can be used as methods or contexts.
When used as methods, they are initializing Hydra globally and should only be called once.
When used as contexts, they are initializing Hydra within the context can be used multiple times.
Like <b>@hydra.main()</b> all three support the [version_base](../upgrades/version_base.md) parameter
to define the compatability level to use.
to define the compatibility level to use.

### Code example
```python
Expand Down Expand Up @@ -88,7 +88,7 @@ def initialize(
- Python modules
- Unit tests
- Jupyter notebooks.
:param version_base: compatability level to use.
:param version_base: compatibility level to use.
:param config_path: path relative to the parent of the caller
:param job_name: the value for hydra.job.name (By default it is automatically detected based on the caller)
:param caller_stack_depth: stack depth of the caller, defaults to 1 (direct caller).
Expand All @@ -105,7 +105,7 @@ def initialize_config_module(
Initializes Hydra and add the config_module to the config search path.
The config module must be importable (an __init__.py must exist at its top level)
:param config_module: absolute module name, for example "foo.bar.conf".
:param version_base: compatability level to use.
:param version_base: compatibility level to use.
:param job_name: the value for hydra.job.name (default is 'app')
"""
```
Expand All @@ -120,7 +120,7 @@ def initialize_config_dir(
The config_dir is always a path on the file system and is must be an absolute path.
Relative paths will result in an error.
:param config_dir: absolute file system path
:param version_base: compatability level to use.
:param version_base: compatibility level to use.
:param job_name: the value for hydra.job.name (default is 'app')
"""
```
Expand Down
8 changes: 4 additions & 4 deletions website/versioned_docs/version-1.2/advanced/compose_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ All 3 can be used as methods or contexts.
When used as methods, they are initializing Hydra globally and should only be called once.
When used as contexts, they are initializing Hydra within the context can be used multiple times.
Like <b>@hydra.main()</b> all three support the [version_base](../upgrades/version_base.md) parameter
to define the compatability level to use.
to define the compatibility level to use.

### Code example
```python
Expand Down Expand Up @@ -88,7 +88,7 @@ def initialize(
- Python modules
- Unit tests
- Jupyter notebooks.
:param version_base: compatability level to use.
:param version_base: compatibility level to use.
:param config_path: path relative to the parent of the caller
:param job_name: the value for hydra.job.name (By default it is automatically detected based on the caller)
:param caller_stack_depth: stack depth of the caller, defaults to 1 (direct caller).
Expand All @@ -105,7 +105,7 @@ def initialize_config_module(
Initializes Hydra and add the config_module to the config search path.
The config module must be importable (an __init__.py must exist at its top level)
:param config_module: absolute module name, for example "foo.bar.conf".
:param version_base: compatability level to use.
:param version_base: compatibility level to use.
:param job_name: the value for hydra.job.name (default is 'app')
"""
```
Expand All @@ -120,7 +120,7 @@ def initialize_config_dir(
The config_dir is always a path on the file system and is must be an absolute path.
Relative paths will result in an error.
:param config_dir: absolute file system path
:param version_base: compatability level to use.
:param version_base: compatibility level to use.
:param job_name: the value for hydra.job.name (default is 'app')
"""
```
Expand Down
8 changes: 4 additions & 4 deletions website/versioned_docs/version-1.3/advanced/compose_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ All 3 can be used as methods or contexts.
When used as methods, they are initializing Hydra globally and should only be called once.
When used as contexts, they are initializing Hydra within the context can be used multiple times.
Like <b>@hydra.main()</b> all three support the [version_base](../upgrades/version_base.md) parameter
to define the compatability level to use.
to define the compatibility level to use.

### Code example
```python
Expand Down Expand Up @@ -88,7 +88,7 @@ def initialize(
- Python modules
- Unit tests
- Jupyter notebooks.
:param version_base: compatability level to use.
:param version_base: compatibility level to use.
:param config_path: path relative to the parent of the caller
:param job_name: the value for hydra.job.name (By default it is automatically detected based on the caller)
:param caller_stack_depth: stack depth of the caller, defaults to 1 (direct caller).
Expand All @@ -105,7 +105,7 @@ def initialize_config_module(
Initializes Hydra and add the config_module to the config search path.
The config module must be importable (an __init__.py must exist at its top level)
:param config_module: absolute module name, for example "foo.bar.conf".
:param version_base: compatability level to use.
:param version_base: compatibility level to use.
:param job_name: the value for hydra.job.name (default is 'app')
"""
```
Expand All @@ -120,7 +120,7 @@ def initialize_config_dir(
The config_dir is always a path on the file system and is must be an absolute path.
Relative paths will result in an error.
:param config_dir: absolute file system path
:param version_base: compatability level to use.
:param version_base: compatibility level to use.
:param job_name: the value for hydra.job.name (default is 'app')
"""
```
Expand Down

0 comments on commit 74cbabc

Please sign in to comment.