-
Notifications
You must be signed in to change notification settings - Fork 17
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improve error handling/rendering #289
Conversation
felixfontein
commented
Jun 29, 2024
•
edited
Loading
edited
- Render errors as text code blocks, instead of using the default lexer (which happens to be YAML + Jinja2 for the Ansible docsite, for example, resulting in warnings).
- Improve handling of empty and broken changelogs.
- Remove leading spaces in RST paragraphs, to avoid them being interpreted as blockquotes.
TODO: (now done in 0e10ab9) description: >
Includes both the Generic Ip Pool and Tunnel Ip Pool.
Generic - Used for general purpose within the network such as device
management or communication between the network devices.
Tunnel - Designated for the tunnel interfaces to encapsulate packets
within the network protocol. It is used in VPN connections,
GRE tunnels, or other types of overlay networks. causes
Let's see whether we can improve this. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Thanks for making that one variable name more descriptive @felixfontein - I was also thinking about how to improve some of the readability here but that would probably mean refactoring the logic for handling the first line and blank lines. Anyway everything seems fine from what I can tell and I don't want to make a bunch of excessive comments. 😸
Thanks very much! 🎉
@oraNod thanks for reviewing this! |