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

[Documentation] Specify Input Type Limitations for PinSiteData and SiteData Methods #180

Open
yanli-dev opened this issue Dec 10, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@yanli-dev
Copy link

Description:

The PinSiteData and SiteData methods accept a variety of input types . However, it seems these methods may throw exceptions when the input type is not supported by mathematical operations. Currently, there is no detailed documentation outlining the specific limitations or constraints on the types of inputs that are supported.

Suggestion:

Update the documentation to specify:

  • The supported input types <T> (e.g., int, float, double, etc.).
  • What happens when unsupported types are used (e.g., exceptions, fallback mechanisms).
  • Include examples of valid and invalid input types.
  • Optionally, provide recommendations or safeguards for users to ensure compatibility with mathematical operations.
@yanli-dev yanli-dev added the enhancement New feature or request label Dec 10, 2024
@Mattjet27 Mattjet27 added the documentation Improvements or additions to documentation label Dec 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants