Skip to content

Commit 2e9be45

Browse files
[DOCUMENTATION] Revert buggy ref links to fix regressions (- WIP PR #228 -)
Changes in file docs/Exception_Guide.md: - revert to direct links to fix regression.
1 parent e1db75a commit 2e9be45

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

docs/Exception_Guide.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This document provides an in-depth overview of the error handling mechanisms wit
44
It details the exceptions used, their meanings, associated exit codes, and examples of when and
55
how they are raised in the codebase. The guide aims to standardize error handling practices and
66
ensure consistency across the project, aligning with
7-
[CEP-8](cep8) standards.
7+
[CEP-8](https://gist.github.com/reactive-firewall/b7ee98df9e636a51806e62ef9c4ab161) standards.
88

99
## Exceptions Overview
1010

@@ -149,7 +149,7 @@ project's `EXIT_CODES` mapping.
149149

150150
The `EXIT_CODES` dictionary in `multicast/exceptions.py` provides a centralized mapping between
151151
exit codes, exceptions, and messages, adhering to
152-
[CEP-8](cep8).
152+
[CEP-8](https://gist.github.com/reactive-firewall/b7ee98df9e636a51806e62ef9c4ab161).
153153

154154
For clarity, here's the standard mapping:
155155

@@ -212,7 +212,7 @@ EXIT_CODES = {
212212
213213
The following mappings are specific to multicast exceptions and may differ from the standard
214214
mappings above (while still remaining
215-
[CEP-8](cep8)
215+
[CEP-8](https://gist.github.com/reactive-firewall/b7ee98df9e636a51806e62ef9c4ab161)
216216
compliant):
217217

218218
| Exception | Exit Code | Reason for Customization |
@@ -305,9 +305,10 @@ context.
305305
- **Clear Error Messages**: Provide informative and clear error messages to aid in debugging and
306306
user understanding.
307307
- **Adherence to Standards**: Follow the guidelines set out in
308-
[CEP-8](cep8) and the
308+
[CEP-8](https://gist.github.com/reactive-firewall/b7ee98df9e636a51806e62ef9c4ab161) and the
309309
project's conventions for error handling and exit codes.
310310

311+
311312
## Adding New Exceptions
312313

313314
When introducing new exceptions:
@@ -331,7 +332,4 @@ provide a better experience for users interacting with the software.
331332

332333
### Copyright (c) 2024-2025, Mr. Walls
333334

334-
[![License - MIT](https://img.shields.io/github/license/reactive-firewall/multicast.svg?maxAge=3600)](license)
335-
336-
[cep8]: https://gist.github.com/reactive-firewall/b7ee98df9e636a51806e62ef9c4ab161
337-
[license]: https://github.com/reactive-firewall/multicast/blob/stable/LICENSE.md
335+
[![License - MIT](https://img.shields.io/github/license/reactive-firewall/multicast.svg?maxAge=3600)](https://github.com/reactive-firewall/multicast/blob/stable/LICENSE.md)

0 commit comments

Comments
 (0)