From 71a6fceb8c72ffb75c0fe91b273fff1d8a261219 Mon Sep 17 00:00:00 2001
From: Rob Cowsill <42620235+rcowsill@users.noreply.github.com>
Date: Wed, 11 Jan 2023 19:12:52 +0000
Subject: [PATCH] core: Update "core.error" documentation (#905)

Change the `core.error` documentation to say that it won't automatically
fail the action. This matches the existing example in the "logging" section
---
 packages/core/README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/packages/core/README.md b/packages/core/README.md
index 9be3f26d..8a471430 100644
--- a/packages/core/README.md
+++ b/packages/core/README.md
@@ -121,7 +121,7 @@ const result = await core.group('Do something async', async () => {
 
 This library has 3 methods that will produce [annotations](https://docs.github.com/en/rest/reference/checks#create-a-check-run). 
 ```js
-core.error('This is a bad error. This will also fail the build.')
+core.error('This is a bad error, action may still succeed though.')
 
 core.warning('Something went wrong, but it\'s not bad enough to fail the build.')