docs(maintenance): add clarification about async decorators

[dreamorosi]

Description of your changes

The class method decorators offered by the project are currently implemented in a way that fits asynchronous methods. When decorating an asynchronous method everything works as intended. When instead decorating a synchronous method, the decorator replaces its implementation with an asynchronous one causing the caller to have to await the now decorated method.

This was previously not explicitly called out and caused confusion for some customers.

This PR adds a callout in the docs to document this behavior.

Related issues, RFCs

Issue number: closes #1204

Checklist

• My changes meet the tenets criteria
• I have performed a self-review of my own code
• I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my change is effective and works
• The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

• I have documented the migration process
• I have added, implemented necessary warnings (if it can live side by side)

---

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information