Skip to content

Comments

Update, correct, and expand documentation#747

Merged
nicolas-abril merged 19 commits intoHigherOrderCO:mainfrom
In-Veritas:Gabriel_doc
Feb 3, 2025
Merged

Update, correct, and expand documentation#747
nicolas-abril merged 19 commits intoHigherOrderCO:mainfrom
In-Veritas:Gabriel_doc

Conversation

@In-Veritas
Copy link
Contributor

Summary of Changes

This pull request includes the following updates and improvements:

Documentation Updates

  • Guide.md and Features.md:

    • Updated and clarified information to ensure accuracy and better readability.
    • Expanded sections that were previously incomplete or unclear.
    • Added new examples to better illustrate key concepts.
  • Docs Folder:

    • Reviewed and revised most files in the docs folder for consistency and clarity.
    • Addressed gaps in explanations and improved structure for easier navigation.

Code Examples

  • Corrected example code snippets that previously failed to execute correctly.
  • Verified and tested all examples to ensure they work as intended.

Inline Comments

  • Added inline comments when describing built-in functions.
    • These comments provide detailed explanations of the purpose and usage of each function.

Type Declarations

  • Declared types for every function in the documentation.

Additional Notes

These changes aim to make the documentation more comprehensive, easier to understand, and practical for both new and experienced users. Feedback and suggestions for further improvements are welcome

In-Veritas and others added 4 commits January 17, 2025 16:20
Co-authored-by: Nicolas Abril <y906846m@anonaddy.me>
Co-authored-by: Nicolas Abril <y906846m@anonaddy.me>
In-Veritas and others added 2 commits January 31, 2025 18:13
Co-authored-by: Nicolas Abril <nicolas.abril@protonmail.ch>
Co-authored-by: Nicolas Abril <nicolas.abril@protonmail.ch>
@nicolas-abril
Copy link
Member

Looks like a new clippy version is breaking the checks, can you apply the suggested changes? (replace map_or(false, ...) for is_some_and(...))

@nicolas-abril nicolas-abril added this pull request to the merge queue Feb 3, 2025
@nicolas-abril
Copy link
Member

Looks good, thank you

Merged via the queue into HigherOrderCO:main with commit 0ac443c Feb 3, 2025
5 checks passed
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.

2 participants