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

Small Problem with API Docu for sap.suite.ui.microchart.ColumnMicroChart #86

Closed
DerGuteWolf opened this issue Oct 25, 2023 · 7 comments
Closed
Assignees
Labels
not-doc-issue Reported issue is not a documentation issue. type/content-gaps Something essential is missing in the documentation.

Comments

@DerGuteWolf
Copy link
Contributor

Issue description

"When no custom tooltip is defined, the tooltip is generated automatically based on the logic described in sap.ui.core.Element#getTooltip_AsString."

Unfortunatly there is no (longer?) description of any logic behind the link.

Feedback Type (Optional)

content gaps

Page Title on SAP Help Portal (prefilled)

sap.suite.ui.microchart.ColumnMicroChart - API Reference - Demo Kit - SAPUI5 SDK

Page URL on SAP Help Portal (prefilled)

https://ui5.sap.com/#/api/sap.suite.ui.microchart.ColumnMicroChart%23overview

@KvM2
Copy link
Contributor

KvM2 commented Oct 26, 2023

Hi @DerGuteWolf , Thanks for your contribution and the observation! Since this is about the API documentation and not the developer guide, would you mind giving this feedback in a different channel, for example, the Demo Kit feedback channel? Thanks!

@DerGuteWolf
Copy link
Contributor Author

Hi @KvM2, I was a bit unsure what to use for feedback for UI5-only API documentation. Could you elaborate a bit what you mean with "Demo Kit feedback channel"?

@KvM2
Copy link
Contributor

KvM2 commented Oct 27, 2023

Hi @DerGuteWolf, the Demo Kit feedback (Feedback icon in Demo Kit) is not perfectly suitable (since it is mostly a survey ), but here is a Github repository you can use for issues with the API documentation : https://github.com/SAP/openui5-docs/
This would fit, since the issue is related to API within OpenUI5.
Katja

@KvM2
Copy link
Contributor

KvM2 commented Nov 2, 2023

Hi @DerGuteWolf, can you let me know if this info helped? I will then close this issue. Thanks

@KvM2
Copy link
Contributor

KvM2 commented Nov 7, 2023

Hi @DerGuteWolf, I just checked again: the feedback icon (and then the button Give Feedback rather than the survey) is fine as well. There is a field where you can enter free text and say if it is related to the current (API) page you are on, just in case you don't know this.

@KvM2
Copy link
Contributor

KvM2 commented Nov 15, 2023

Hi @DerGuteWolf, The link I added was actually another one for (developer guide) documentation. My apologies. This is the one I wanted to mention in the first place: https://github.com/SAP/openui5/issues.

@OlMue OlMue added the type/content-gaps Something essential is missing in the documentation. label Nov 24, 2023
@KvM2 KvM2 self-assigned this Dec 6, 2023
@KvM2
Copy link
Contributor

KvM2 commented Dec 12, 2023

I am closing this now since this has been open for some time and needs to be addressed in another channel , since it is about the API documentation. Let us know if you still have any feedback.

@KvM2 KvM2 closed this as completed Dec 12, 2023
@KvM2 KvM2 added the not-doc-issue Reported issue is not a documentation issue. label Dec 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
not-doc-issue Reported issue is not a documentation issue. type/content-gaps Something essential is missing in the documentation.
Projects
None yet
Development

No branches or pull requests

3 participants