Skip to content

Commit

Permalink
docs: fix wrong package name, should be Errors C++
Browse files Browse the repository at this point in the history
  • Loading branch information
threeal committed Jan 4, 2024
1 parent 96db0b2 commit d9bb31d
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Error C++
# Errors C++

[![version](https://img.shields.io/github/v/release/threeal/errors-cpp?style=flat-square)](https://github.com/threeal/errors-cpp/releases)
[![license](https://img.shields.io/github/license/threeal/errors-cpp?style=flat-square)](./LICENSE)
[![build status](https://img.shields.io/github/actions/workflow/status/threeal/errors-cpp/build.yaml?branch=main&style=flat-square)](https://github.com/threeal/errors-cpp/actions/workflows/build.yaml)
[![test status](https://img.shields.io/github/actions/workflow/status/threeal/errors-cpp/test.yaml?branch=main&&label=test&style=flat-square)](https://github.com/threeal/errors-cpp/actions/workflows/test.yaml)
[![deploy status](https://img.shields.io/github/actions/workflow/status/threeal/errors-cpp/deploy.yaml?branch=main&label=deploy&style=flat-square)](https://github.com/threeal/errors-cpp/actions/workflows/deploy.yaml)

Error C++ is a [C++](https://isocpp.org/) package that provides utilities for error handling.
Errors C++ is a [C++](https://isocpp.org/) package that provides utilities for error handling.
This package mainly consists of the `errors::Error` class, representing an object that may contain an error.

This package serves as an alternative to error handling using [try-catch exceptions](https://en.cppreference.com/w/cpp/language/try_catch), commonly found in C++ code.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Errors C++
=============

Error C++ is a `C++`_ package that provides utilities for error handling.
Errors C++ is a `C++`_ package that provides utilities for error handling.
This package mainly consists of the `errors::Error` class, representing an object that may contain an error.

This package serves as an alternative to error handling using `try-catch exceptions`_, commonly found in C++ code.
Expand Down

0 comments on commit d9bb31d

Please # to comment.