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

InputMap's with_one_to_many and insert_one_to_many display many to one behavior in contradiction to documentation #596

Open
TrialDragon opened this issue Aug 13, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone

Comments

@TrialDragon
Copy link

What problem did the developer encounter?

Whilst reading the docs I noticed that the with_one_to_many function and insert_one_to_many function displays a many to one behavior per the earlier docs which seems backwards.

InputMap#many_to_one_mapping
InputMap#method.with_one_to_many
InputMap#method.insert_one_to_many

How could this be better documented?

Either change the name to with_many_to_one and insert_many_to_one or correct the earlier docs to put the current many to one documentation under one to many and vice versa.

@TrialDragon TrialDragon added the documentation Improvements or additions to documentation label Aug 13, 2024
@alice-i-cecile
Copy link
Contributor

Yep, the names should just be swapped at this point!

@alice-i-cecile alice-i-cecile added the good first issue Good for newcomers label Aug 13, 2024
@alice-i-cecile alice-i-cecile modified the milestones: 0.15.1, 0.15.2 Aug 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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants