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

Fix duplicate link references in README #7020

Merged
merged 1 commit into from
Jan 25, 2025

Conversation

Jefffrey
Copy link
Contributor

Markdown can't handle multiple reference links with same name. i.e.

Check out [this link].

[this link]: https://github.com/apache/arrow-rs

Now how about [this link].

[this link]: https://github.com/apache/datafusion

The link on Now how about this link will point to arrow-rs instead of datafusion.

Example of how that's affecting current README:

image

For now I've decided to include the issue number as part of the text so the reference links have unique names.

Alternatives were either slightly change the text, like making the second one:

See [this issue] for more nuances.

Which I didn't like as I feel we may fall into this issue again.

Another alternative would be to inline both:

Check out [this link](https://github.com/apache/arrow-rs).

Now how about [this link](https://github.com/apache/datafusion)

Don't have a particular preference for that or current approach.

Copy link
Contributor

@etseidl etseidl left a comment

Choose a reason for hiding this comment

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

Nice catch! I think in this case including the issue number in the text is the right way to go. But I'd be fine with [text](url) as well if others have a strong preference.

Copy link
Contributor

@alamb alamb left a comment

Choose a reason for hiding this comment

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

I agree -- this looks great -- thanks @Jefffrey

@tustvold tustvold merged commit 4862318 into apache:main Jan 25, 2025
9 checks passed
@Jefffrey Jefffrey deleted the fix-readme-link branch January 25, 2025 22:21
@alamb alamb added the documentation Improvements or additions to documentation label Jan 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants