Skip to content

Conversation

@wyatt-wong
Copy link

No description provided.

@wyatt-wong wyatt-wong requested a review from a team as a code owner March 22, 2025 06:19
@ghost
Copy link

ghost commented Mar 22, 2025

The following commit authors need to sign the Contributor License Agreement:

Click the button to sign:
CLA not signed

@StanFromIreland
Copy link
Member

The current example is fine, this will just raise more questions with people who are not familiar with bash.

@ned-deily
Copy link
Member

Thank you for the PR but I agree that trying to refine the example this way is more likely to confuse than clarify.

@ned-deily ned-deily closed this Mar 22, 2025
@wyatt-wong
Copy link
Author

The current example is fine, this will just raise more questions with people who are not familiar with bash.

They don't need to be familiar with bash at all. Furthermore for those who want to build from the GitHub source they should be basic knowledge in macOS shell. Otherwise they don't even know how to setup the build environment.

When I read the example using the username of ronald, it totally confused me into believing it is the correct statement to copy and paste to the macOS Terminal. But I re-read it and found that it is just an example so I prefer to generalize it to use the current username instead.

So in short, I totally disagree with your decision.

@wyatt-wong
Copy link
Author

Thank you for the PR but I agree that trying to refine the example this way is more likely to confuse than clarify.

As per my reply to the previous user, I disagreed and I prefer to generalize it.

@wyatt-wong
Copy link
Author

wyatt-wong commented Mar 23, 2025

I would counter-propose to mention donald is only an example and it should be replaced by the current username which can be found using id -un in macOS environment.

The information in README.rst should as accurate as possible and as precise as possible for the specific OS environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

3 participants