Skip to content

Commit

Permalink
Update README to new GitHub markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
Bluenix2 committed Jul 22, 2024
1 parent bca3d7d commit ac80274
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ class Data:
value: Any
```

> **Note**
> [!NOTE]
> It is not recommended to import the library this way, as it does not allow
> you to introspect the annotations in other code. It is merely pointed out
> for completeness.
Expand Down Expand Up @@ -110,12 +110,12 @@ As a reminder of semantic versioning, and a summary of the above:
| **Minor** | X | | May add new features, can break type-checking |
| **Patch** | X | X | Only intended for bugs |

> **Warn**
> [!WARNING]
> Patch versions will be used to rectify any accidental breaking changes
> or unintended bugs / behaviour, therefore you should **always** use
> the latest patch version.
> **Note**
> [!NOTE]
> Because patch versions may change previous behaviour, they *could* be
> considered breaking, however the intention is always to fix unintended
> behaviour or previous breaking changes which should not have been.
Expand Down

0 comments on commit ac80274

Please sign in to comment.