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: Describe why certain implementations (e.g. ion-loading) are described as recommended #3669

Open
Alextremeee opened this issue May 24, 2024 · 0 comments
Labels
content Issues related to the contents of the documentation website

Comments

@Alextremeee
Copy link

Alextremeee commented May 24, 2024

Describe Problem

For example the documentation of ion-loading describes both an inline and controller implementation, but describes the inline one as recommended without explaining why.

It would be useful to know why this is recommended at this point in the documentation as it may inform your decision about how to implement something. For example, a controller-based implementation of ion-loading may seem preferable to my use case, but if I don't know why an inline implementation is recommended it's harder to make a good choice.

Is this recommendation simply for code clarity, or does it provide a benefit to the end user?

Describe Preferred Solution

I believe there are a few components that have the same description so this could just be a link to a page describing why inline implementations are preferable.

Describe Alternatives

No response

Additional Information

https://ionicframework.com/docs/api/loading#inline-recommended

@Alextremeee Alextremeee added the triage New issues label May 24, 2024
@Alextremeee Alextremeee changed the title feat: Describe why certain implementations (e.g. ion-loading) have described as recommended feat: Describe why certain implementations (e.g. ion-loading) are described as recommended May 24, 2024
@brandyscarney brandyscarney changed the title feat: Describe why certain implementations (e.g. ion-loading) are described as recommended docs: Describe why certain implementations (e.g. ion-loading) are described as recommended Jun 3, 2024
@brandyscarney brandyscarney added content Issues related to the contents of the documentation website and removed triage New issues labels Jun 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Issues related to the contents of the documentation website
Projects
None yet
Development

No branches or pull requests

2 participants