From 5146b012a450629f2d2d195d71988b0849e5f476 Mon Sep 17 00:00:00 2001 From: Sherwin Varghese <141290943+Sherwin-14@users.noreply.github.com> Date: Mon, 15 Jul 2024 11:37:22 +0530 Subject: [PATCH] Corrected some semantics Co-authored-by: Matt Fisher --- docs/user_guide/backwards-compatibility.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user_guide/backwards-compatibility.md b/docs/user_guide/backwards-compatibility.md index 4bb18312..c5771e24 100644 --- a/docs/user_guide/backwards-compatibility.md +++ b/docs/user_guide/backwards-compatibility.md @@ -6,7 +6,7 @@ We care deeply about minimizing negative impacts of changes to earthaccess, but We use [Semantic Versioning (SemVer)](https://semver.org/) to tell users what to expect when upgrading. We recommend following the link to learn more, but here are the important ways this affects you: - 1. There are 3 version parts: MAJOR.MINOR.PATCH (e.g. 1.2.3 is major version 1, minor release 2, patch release 3). + 1. There are 3 version parts: `MAJOR.MINOR.PATCH` (e.g. `1.2.3` is major version `1`, minor release `2`, patch release `3`). 2. When the major version changes, anything can break! Always visit this documentation before doing a major upgrade. 3. When the minor version changes, new features should be available, but nothing should break. Visit the documentation to learn about new features. 4. When the patch version changes, only bugfixes should be included. Visit the CHANGELOG to learn more about the fixes.