Skip to content
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

Change bullet * to - for readability due to adjacent ** #1555

Merged
merged 1 commit into from
Sep 25, 2024

Conversation

JFWooten4
Copy link
Contributor

In re D799, stars for bullet points make my insides repulse, especially when the label thereater is bold with stars.1

Footnotes

  1. See also parallel code at C118–123 and all SEP info employing hyphens.

Copy link
Member

@leighmcculloch leighmcculloch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1, this document is pretty hard on the eyes having the adjacent use of asterisk for the list and bold, e.g. * **Draft**.

Merging to improve the readability in this one case, not to set a goal of formatting consistent. Any attempt to make formatting consistent needs to include automation, otherwise it won't stick.

This repo already automates the formatting of the ecosystem/ folder using prettier, and maybe could adopt automation of the core/ folder too. However, I think there's also little value in doing that either. The contents of the core/ folder are short-lived documents that propose a change to the protocol and are not significantly referenced after implementation and vote.

@leighmcculloch leighmcculloch changed the title 🎨 Upgrade markdown bullet style Change bullet * to - for readability due to adjacent ** Sep 25, 2024
@leighmcculloch leighmcculloch merged commit dda07fb into stellar:master Sep 25, 2024
3 checks passed
@JFWooten4 JFWooten4 deleted the readme-bullet-syntax branch October 10, 2024 22:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants