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

🚀 [READY FOR REVIEW] MONGOID-5564 Code Docs: Make it a rule to use full namespaces in code doc #5548

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

johnnyshields
Copy link
Contributor

@johnnyshields johnnyshields commented Feb 16, 2023

This PR only includes changes to code docs -- no logic changes

The changes for #5547 are also included here for de-confliction purposes. Please merge that one first

Code Docs: Make it a rule to use full namespaces in code doc. This avoids ambiguity for example between Mongoid::Document and BSON::Document.

This PR includes the change for the following classes:

Any stragglers missed can be fixed on an ongoing basis.

@johnnyshields johnnyshields changed the title MONGOID-5564 Code Docs: Make it a rule to use full namespaces in code doc [READY FOR REVIEW] MONGOID-5564 Code Docs: Make it a rule to use full namespaces in code doc Feb 16, 2023
@johnnyshields johnnyshields changed the title [READY FOR REVIEW] MONGOID-5564 Code Docs: Make it a rule to use full namespaces in code doc 🚀 [READY FOR REVIEW] MONGOID-5564 Code Docs: Make it a rule to use full namespaces in code doc Apr 10, 2023
…oids ambiguity for example between Mongoid::Document and BSON::Document.

This PR includes the change for the following classes:
- Mongoid::Document
- Mongoid::Criteria
- Mongoid::Association::Proxy
- Mongoid::Criteria::Queryable

Any stragglers missed can be fixed on an ongoing basis.
@johnnyshields
Copy link
Contributor Author

@jamis @comandeo please kindly merge this PR. It should take about ~5 minutes to scan the diff and see that this only affects code comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant