docs: adds comments to describe the mongo parser - Githubissues

keploy / keploy

Test generation for Developers. Generate tests and stubs for your application that actually work!

https://keploy.io

Apache License 2.0

3.37k stars 374 forks source link

docs: adds comments to describe the mongo parser #1818

Open re-Tick opened 1 month ago

re-Tick commented 1 month ago

Related Issue

Info about Issue or bug

Closes: #[issue number that will be closed through this PR]

Describe the changes you've made

Adds comment to describe the flow of the mongo parser.

Type of change

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Code style update (formatting, local variables)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] This change requires a documentation update

Please let us know if any test cases are added

Please describe the tests(if any). Provide instructions how its affecting the coverage.

Describe if there is any unusual behaviour of your code(Write `NA` if there isn't)

A clear and concise description of it.

Checklist:

[x] My code follows the style guidelines of this project.
[x] I have performed a self-review of my own code.
[x] I have commented my code, particularly in hard-to-understand areas.
[x] I have made corresponding changes to the documentation.
[x] My changes generate no new warnings.
[x] I have added tests that prove my fix is effective or that my feature works.
[x] New and existing unit tests pass locally with my changes.