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

Update TROUBLESHOOTING.md to reflect Builder methods name changes #174

Merged
merged 2 commits into from
Feb 6, 2025

Conversation

DivineGod
Copy link
Contributor

Updates to the names of methods on the Builder merged in PR #113 missed updating the TROUBLESHOOTING.md file

Updates to the names of methods on the `Builder` merged in PR almindor#113 missed updating the TROUBLESHOOTING.md file
@DivineGod DivineGod requested a review from almindor as a code owner February 5, 2025 20:51
@rfuest
Copy link
Collaborator

rfuest commented Feb 6, 2025

Good catch!

There's another part of the document that hasn't been updated in line 26, where Builder::ili9486_rgb666(di) instead of the current Builder::new(ILI9486Rgb666, di). Could you also fix that while you are at it?

@almindor: I had previously suggested to move the troubleshooting doc into the rustdoc docs (#76). My primary concern in that issue was that the troubleshooting doc isn't versioned and that older versions on docs.rs won't link to the correct version of the troubleshooting doc. But this issue shows that there would be another benefit of integrating the troubleshooting guide into the rustdoc docs, which is that we could run doc tests to make sure the code examples remain valid. What is your opinion on this?

Update the Builder pattern usage in Troubleshooting docs to reflect latest changes
@DivineGod
Copy link
Contributor Author

There's another part of the document that hasn't been updated in line 26, where Builder::ili9486_rgb666(di) instead of the current Builder::new(ILI9486Rgb666, di). Could you also fix that while you are at it?

Done

Copy link
Collaborator

@rfuest rfuest left a comment

Choose a reason for hiding this comment

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

Thanks!

@rfuest rfuest merged commit e1b6100 into almindor:master Feb 6, 2025
15 checks passed
@DivineGod DivineGod deleted the patch-1 branch February 6, 2025 22:47
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