Skip to content

Missing documentation and example #18

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

Open
KAbhijeet2105 opened this issue Apr 3, 2020 · 3 comments
Open

Missing documentation and example #18

KAbhijeet2105 opened this issue Apr 3, 2020 · 3 comments
Labels
type: imperfection Perceived defect in any part of project

Comments

@KAbhijeet2105
Copy link

In the Arduino TFT library, there is a function to draw triangle but, the documentation and example are missing. Ref.- https://www.arduino.cc/en/Reference/TFTLibrary here documentation is not present about the triangle() method.

@KAbhijeet2105
Copy link
Author

#17 : Example of the triangle() method added.
How can I add documentation about triangle() method in
https://www.arduino.cc/en/Reference/TFTLibrary.

@per1234
Copy link
Contributor

per1234 commented Apr 3, 2020

How can I add documentation about triangle() method in
https://www.arduino.cc/en/Reference/TFTLibrary.

The library reference content is not hosted in a public repository, so it is not possible to submit a pull request to make changes to that content. What you can do is provide the exact text you propose be added in an issue here. Ideally, this would result in the process of publishing the new documentation being mostly a copy/paste operation for the person with the write access to that content.

You should take note that this library has been placed under the "RETIRED" section in the Arduino IDE's File > Examples menu, so it may be that work on its documentation won't be considered a high priority.

@KAbhijeet2105
Copy link
Author

How can I add documentation about triangle() method in
https://www.arduino.cc/en/Reference/TFTLibrary.

The library reference content is not hosted in a public repository, so it is not possible to submit a pull request to make changes to that content. What you can do is provide the exact text you propose be added in an issue here. Ideally, this would result in the process of publishing the new documentation being mostly a copy/paste operation for the person with the write access to that content.

You should take note that this library has been placed under the "RETIRED" section in the Arduino IDE's File > Examples menu, so it may be that work on its documentation won't be considered a high priority.

Thank you so much for your valuable feedback.
Please also review #17 this PR and suggest necessary changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: imperfection Perceived defect in any part of project
Projects
None yet
Development

No branches or pull requests

2 participants