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

fix: Add missing documentation about navigation properties #200

Merged

Conversation

skolmer
Copy link
Contributor

@skolmer skolmer commented Aug 14, 2024

Description

This adds missing documentation about auto generating maps for navigation properties and key based access.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist

  • I have performed a self-review of my code
  • I have added tests that prove my fix is effective or that my feature works
  • I have made corresponding changes to the documentation
  • I have commented my code, particularly in hard-to-understand areas
  • New and existing unit tests pass locally with my changes

Copy link

what-the-diff bot commented Aug 14, 2024

PR Summary

  • Updated documentation for gridifyMapper.md on controlling depth of mappings
    The team has added more details in the documentation about how to specify a parameter called maxNestingDepth. This can give users better control over the depth at which the mappings occur in the program.

  • Added support for navigation properties in gridifyMapper.md documentation
    The updated documentation now includes how to handle navigation properties within the mappings, enhancing the flexibility of the software tool's functionality.

  • Documentation for new methods: ClearMaps and GetCurrentMaps
    Information about two new methods, ClearMaps and GetCurrentMaps, has been introduced in the documentation for gridifyMapper.md. ClearMaps helps remove all existing mappings while GetCurrentMaps gives an overview of the current mapping setup. These methods provide more control over the tool's functionalities to the users, making it easier for them to manage and understand their mappings.

@alirezanet alirezanet merged commit 20ae059 into alirezanet:master Aug 14, 2024
3 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