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

style(guide): Consistency in the wording of hardlinks vs hard links #2171

Merged

Conversation

TRaSH-
Copy link
Contributor

@TRaSH- TRaSH- commented Dec 22, 2024

Pull Request

Purpose

Consistency in the wording of hardlinks vs hard links

Approach

Checked the consistency in the wording of hard links vs. hardlinks; we went with hardlinks because the Starr apps use hard links, and the guide is based on the Starr apps. (See message at the bottom)
Sections where the GUI shows hard links we left as hard links.

I received the following reply, and I think this might be the best option.

i think the bigger point than grammar with this particular instance is the colloquial usage and acceptance of the term as "hardlink"
given that, for the purpose and entire point of your guide being generally arr related, they've set the stage of it being hardlink
i would go with that.
its not always a matter of being "technically grammar correct"
as much as being consistent, making your point clear, and being easy to follow
documentation is sometimes a balance between language and purpose
and in this case, i would argue that its better to be consistent across the apps users are using and your guide, than to take the high ground of "AI approves our usage of the term!" or something

Open Questions and Pre-Merge TODOs

Requirements

@github-actions github-actions bot added Area: Backend Backend Changes, not related to a specific section Area: Downloaders Downloaders Related labels Dec 22, 2024
@TRaSH- TRaSH- linked an issue Dec 22, 2024 that may be closed by this pull request
@TRaSH- TRaSH- requested a review from a team December 22, 2024 11:26
@bakerboy448 bakerboy448 merged commit acc60f5 into master Dec 22, 2024
12 checks passed
@bakerboy448 bakerboy448 deleted the style/guide-consistency-in-the-wording-of-hardlinks branch December 22, 2024 22:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Backend Backend Changes, not related to a specific section Area: Downloaders Downloaders Related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature] (Guide): Check for consistency in the wording of 'hardlinks'
2 participants