Skip to content

Commit

Permalink
Merge branch 'dev' into ENH/yaml_substitutions
Browse files Browse the repository at this point in the history
  • Loading branch information
gadorlhiac committed May 17, 2024
2 parents 6a560a0 + 7667be8 commit 1659b63
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,8 @@ my_var: Union[str, int] = get_str_or_int()
```
The `typing` module contains many other useful features for type hint support.

Note that it is possible to use `from __future__ import annotations` to enable the use of these features. It is a breaking change and is used on a module-by-module basis, please investigate if it applies to your use case.


### Commit Messages
Inspired by `pcdshub` repositories, in turn following [NumPy conventions](https://numpy.org/doc/stable/dev/development_workflow.html#writing-the-commit-message), all commit messages should ideally be prefixed by a three letter acronym. Each of these acronyms has a specific meaning, making it easy to discern at a glance what the intended purpose of the commit is (bug fix, new feature, etc.). Pull (merge) request titles, and origin branches, should use the same acronyms. The following acronyms are in use:
Expand Down

0 comments on commit 1659b63

Please sign in to comment.