Add OOP Documentation: Inheritance, Methods, Attributes & Access Modifiers#2725
Conversation
|
Thank you for submitting your pull request, @ArshiBansal! 🙌 We'll review it as soon as possible. If there are any specific instructions or feedback regarding your PR, we'll provide them here. Thanks again for your contribution to our Algo project! 😊 |
There was a problem hiding this comment.
Code Review
This pull request adds four new documentation files covering core C++ OOP concepts: attributes, constructors, methods, and access modifiers. The review feedback highlights several critical issues across all files, including improperly escaped markdown front matter that will break Docusaurus parsing, and code blocks containing escaped characters and HTML entities. Additionally, the reviewer noted C++ code quality issues such as an uninitialized member variable in attributes.md, a missing <string> header in constructors.md, and a lack of const-correctness in methods.md.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
⚡️ Lighthouse Report for the Deploy Preview of this PR 🚀
|
ajay-dhangar
left a comment
There was a problem hiding this comment.
Please follow our documentation structure and carefully read the contribution guidelines.
|
@ajay-dhangar i checked the issues where it is failing. the issues are to be found in /home/runner/work/algo/algo/scripts/temp_verify.py which was not used by be. If any of the 4 files i made has the issue could please help me figure those out. |
ajay-dhangar
left a comment
There was a problem hiding this comment.
You need to update or rewrite your code because the entire documentation does not meet our expectations.
|
@ajay-dhangar done |
🎉 Contribution Merged!Thank you so much, @ArshiBansal, for your contribution! Your pull request #2725 has been successfully merged. We truly appreciate your time and effort in making this Algo project better for the community. Keep up the amazing work! 🚀✨ |
📥 Pull Request
Description
This PR adds comprehensive documentation for core OOP concepts in C++ to the Algo project documentation site.
Changes included:
inheritance.md- Detailed guide on inheritance, types, and diamond problemwriting-documentation.md- Guidelines for writing Docusaurus documentationmethods.md- Methods, parameters, instance vs static, best practicesattributes.md- Attributes, fields vs properties, getters/setters, encapsulationaccess-modifiers.md- Public, private, protected access with examples and benefitsThese pages follow consistent style, include code examples with outputs, tables, and Docusaurus best practices.
Motivation: Improve developer onboarding and provide clear reference material for C++ OOP fundamentals.
closes #2676
Type of change
Checklist: