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

Document oslmath #37

Merged
merged 1 commit into from
Aug 31, 2024
Merged

Document oslmath #37

merged 1 commit into from
Aug 31, 2024

Conversation

dogo
Copy link
Owner

@dogo dogo commented Aug 31, 2024

Description:

This PR enhances the documentation for the OSLib Math functions, which utilize the PSP's Vector Floating Point Unit (VFPU). The updates include:

  • Improved Clarity: Each function's purpose, parameters, and return values are now clearly explained, making it easier for developers to understand the functionality and expected behavior.
  • Consistency: The format and language across all function descriptions have been standardized to ensure uniformity throughout the header file.
  • Additional Details: Relevant information, such as input ranges, specific behaviors, and edge cases, has been added where applicable to provide a comprehensive understanding of each function.
  • Enhanced Readability: Grammar and stylistic improvements have been made to enhance the overall readability and professionalism of the documentation.

These changes aim to make the OSLib Math functions more accessible and easier to use for developers, contributing to better maintainability and usability of the library.

@dogo dogo merged commit da3a1e3 into master Aug 31, 2024
6 checks passed
@dogo dogo deleted the feature/doc-oslmath branch August 31, 2024 23:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant