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 in documentation #1398

Merged
merged 1 commit into from
Aug 23, 2023
Merged

Fix in documentation #1398

merged 1 commit into from
Aug 23, 2023

Conversation

bmitc
Copy link
Contributor

@bmitc bmitc commented Aug 23, 2023

The documentation mentioned join and not in, so the documentation has been corrected. join is the more common name here, so I'd be amenable to that change. But this PR just makes a start at addressing this by correcting the documentation to the currently defined name. It appears that in is intended to be used in a pipeline, as in <path> | in <directory>, which is why the name is slightly off for normal use of joining two paths.

The documentation mentioned `join` and not `in`.
Copy link
Contributor

@JakeSiFive JakeSiFive left a comment

Choose a reason for hiding this comment

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

The next wake is going to be a major version anyway so I think its fine to rename this to join but please run some large build to ensure people aren't using this for something else in a conflicting way.

Copy link
Contributor

@JakeSiFive JakeSiFive left a comment

Choose a reason for hiding this comment

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

Approving in case you don't want to rename it right now

@bmitc
Copy link
Contributor Author

bmitc commented Aug 23, 2023

I'm okay with performing the rename later if there's agreement on actually doing the rename. Given other priorities, I'd probably prefer doing the rename later, just so that we can be careful since it's likely used in a lot of places, as you mentioned.

In other words, I'm good with just the documentation fix if you are. 🙂

@JakeSiFive
Copy link
Contributor

Sounds good to me, go ahead and land it

@bmitc bmitc merged commit 4d7fbda into master Aug 23, 2023
12 checks passed
@bmitc bmitc deleted the fix-in-documentation branch August 23, 2023 23:04
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