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

Review markdown in CHANGELOG #50

Open
Ana06 opened this issue Aug 29, 2018 · 2 comments
Open

Review markdown in CHANGELOG #50

Ana06 opened this issue Aug 29, 2018 · 2 comments

Comments

@Ana06
Copy link
Member

Ana06 commented Aug 29, 2018

I think we should inline the urls to Github, as some of them are just used one and it is obfuscating was it is done. How the authors are referenced can also be improved, check for example how it is done in Rubocop.

@Ana06 Ana06 self-assigned this Aug 29, 2018
@abargnesi
Copy link
Member

Can you elaborate on how in-line URLs are obfuscating in this context?

I value referenced URLs since I commonly read markdown in a text editor. In that scenario having to mentally parse (or skip over) the URL is a distraction.

@Ana06
Copy link
Member Author

Ana06 commented Sep 3, 2018

@abargnesi

Can you elaborate on how in-line URLs are obfuscating in this context?

I value referenced URLs since I commonly read markdown in a text editor. In that scenario having to mentally parse (or skip over) the URL is a distraction.

I am not sure if you prefer having in-line urls or not. I would prefer that they are inline. For some of them we are currently defining a variable at the end of the file which is only once used and you need to check to know where the link actually points. What do you prefer? Either if we decide to use them inline or not, we should fix some of them to make it consistent. There is also at least one link broken at the moment.

In the case of contributors, just the syntax can be simplified.

@Ana06 Ana06 removed their assignment Jul 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants