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

docs: Clean up some documenation #1181

Merged
merged 1 commit into from
Sep 28, 2024
Merged

Conversation

offalynne
Copy link
Contributor

Attribution occurs through project documentation and commit history, not contributor graffiti

Attribution occurs through project documentation and commit history, not contributor graffiti
@davidhedlund
Copy link
Contributor

davidhedlund commented Aug 21, 2024

Attribution occurs through project documentation and commit history, not contributor graffiti

Please restore "# Requires Android 12 or later." and try to use a more friendlier tone next time.

Edit: I originally included my name on this file because it was one of the first I uploaded, and I wanted to keep it updated. This way, people could reach out to me if there were any changes needed in the script that generates this autoconfig from the current RetroArch file. Since I was in the middle of changing my email address, I didn't add it at the time, although I intended to do so later. I was also interested in experimenting with how comments could be added. However, after uploading many files, I realized it was too cumbersome to include my name on each one, so I decided to stop doing it altogether. See more about this .

@offalynne
Copy link
Contributor Author

The comment regarding OS version is unnecessary and irrelevant to the purpose of the project

#1140, #1148, #1149, #1150, #1153, #1156, #1158, #1159, #1160, #1161, #1164, #1168, #1166, #1167, #1171, #1172, #1174, #1175, #1176, #1177 should similarly be amended or closed outright for an excess of redundant and/or outright mistaken commentary and minimal content

@davidhedlund
Copy link
Contributor

davidhedlund commented Aug 23, 2024

The comment regarding OS version is unnecessary and irrelevant to the purpose of the project

#1140, #1148, #1149, #1150, #1153, #1156, #1158, #1159, #1160, #1161, #1164, #1168, #1166, #1167, #1171, #1172, #1174, #1175, #1176, #1177 should similarly be amended or closed outright for an excess of redundant and/or outright mistaken commentary

I understand your concerns about the comments, and I appreciate your feedback. After giving it some thought, I've taken the initiative to remove all comments from the pull requests, including the file associated with this PR. Additionally, I've removed any remaining comments, ensuring that every file is now completely free of comments and everything is clean and streamlined. This includes the file associated with this PR, so please feel free to close this PR at your convenience.

and minimal content

[Edit: It's an overstatement to claim that the PRs have minimal content. Take another look at them now that they are uncommented.]

I want to clarify that I didn't append my name to other files or pull requests. The extensive commenting was part of my efforts to manually alter variables from the generated autoconfig files as I learned how to program a script to automate the process. Additionally, the comments in the autoconfig files were intended to protect them from being downgraded by RetroArch users, a mistake I made myself in the past. To address this, I took measures right away by extensively documenting the principles of the controller drivers in our Joypad Auto Configuration guide to help prevent such issues. So I agree that this repository isn't the right place for these comments any more. Also, creating a dedicated release JSON for the controllers I'm working to maintain would be more appropriate.

Regarding my work with controllers, I currently own the following:

  • Sony DualSense
  • Sony DualShock 4 v2
  • Nintendo Switch Pro Controller

I'm also planning to purchase a Microsoft Series S/X Wireless controller by the end of the month. These controllers are widely available and are the official controllers for modern gaming consoles. My goal is to ensure their compatibility with RetroArch.

I understand it might not be immediately apparent, but reaching this point has required a significant investment of both time and resources. Since May of last year, I've been focused on mastering the generation, modification, and documentation of these autoconfig files. I've also developed configuration scripts for all RetroArch packages, including Flatpak, AppImage, and GNU/Linux packages. This involved dedicating around two months to these efforts, which included submitting the following:

I hope you can understand and support me as I continue to work on these improvements.

davidhedlund added a commit to davidhedlund/docs that referenced this pull request Aug 23, 2024
Text was removed to incorporate comments into the autoconfig files following consensus: libretro/retroarch-joypad-autoconfig#1181 (comment). This user guide is sufficiently documented to serve as a reference instead of including comments within the files.
@davidhedlund
Copy link
Contributor

I just added a commit with edit summary: "Text was removed to incorporate comments into the autoconfig files following consensus: #1181 (comment). This user guide is sufficiently documented to serve as a reference instead of including comments within the files."

@offalynne
Copy link
Contributor Author

I think we have different ideas regarding what "improvement" means in the context of these changes

@davidhedlund
Copy link
Contributor

I think we have different ideas regarding what "improvement" means in the context of these changes

Are my pull requests satisfactory, or is there anything else you'd like me to address?

Copy link
Member

@RobLoach RobLoach left a comment

Choose a reason for hiding this comment

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

I tend to agree here. Much of this is cruft and not needed...

  • Attribution is available through git history, and content is licensed as MIT
  • While backwards compatibility is important, in general we usually try to target the latest drivers/versions of platforms
  • It's known that there are other binding files, as you can see the other binding files in the same directory

@RobLoach RobLoach changed the title Remove redundant description and attribution garbage docs: Clean up some documenation Sep 28, 2024
@RobLoach RobLoach merged commit 26cf799 into libretro:master Sep 28, 2024
1 check passed
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.

3 participants