docs: Adding Code rules page #3915
Open
+1,583
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MelReyCG
requested review from
CusiniM,
OmarDuran,
castelletto1,
dkachuma,
herve-gross,
jhuang2601,
paveltomin and
rrsettgast
as code owners
arng40
reviewed
Nov 26, 2025
jafranc
approved these changes
Dec 3, 2025
Contributor
jafranc
left a comment
jafranc
left a comment
There was a problem hiding this comment.
Looks great ! Maybe there is the work of 2 docs there (or more 😄 )
Comment on lines
1013
to
1019
| Additional Validation Guidelines | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| - Use ``setInputFlag()`` to mark parameters as ``REQUIRED`` or ``OPTIONAL`` | ||
| - Use ``setApplyDefaultValue()`` to provide sensible defaults | ||
| - Use ``setRTTypeName()`` for runtime type validation (e.g., ``rtTypes::CustomTypes::positive``) | ||
| - Document valid ranges in ``setDescription()`` |
Contributor
There was a problem hiding this comment.
Shouldn't it be in the Wrapper section ?
Contributor
Author
There was a problem hiding this comment.
It feels strange to me, as the wrapper section is for documentation requirement. My goal here is to precise validation rules. What do you think?
Contributor
Author
|
Thanks @jafranc for your feedback, I'll take them into account. |
herve-gross
reviewed
Dec 11, 2025
herve-gross
reviewed
Dec 11, 2025
herve-gross
reviewed
Dec 11, 2025
herve-gross
reviewed
Dec 11, 2025
herve-gross
reviewed
Dec 11, 2025
herve-gross
reviewed
Dec 11, 2025
MelReyCG
added
ci: run CUDA builds
jafranc
approved these changes
Jan 9, 2026
src/docs/sphinx/developerGuide/Contributing/CodingPractices.rst
Outdated
Show resolved
Hide resolved
| **Avoid magic values**: | ||
|
|
||
| - **arbitrary values should not be written more than once**, define constants, consider using or extending ``PhysicsConstants.hpp`` / ``Units.hpp``, | ||
| - **Prefer to let appear the calculus of constants** rather than writing its value directly without explaination (constexpr has no runtime cost). |
Contributor
There was a problem hiding this comment.
I would be tempted to include a smooth transition and link to the next page CodeGeosFeatures.rst
MelReyCG
added
flag: no rebaseline
dkachuma
approved these changes
Feb 5, 2026
src/docs/sphinx/developerGuide/Contributing/CodingPractices.rst
Outdated
Show resolved
Hide resolved
| Wrapper Documentation (User-Oriented) | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| All data repository wrappers must be documented with ``setDescription()``. |
Contributor
There was a problem hiding this comment.
I think we should encourage the specification of units where this makes sense.
MelReyCG
added
ci: run CUDA builds
MelReyCG
added
ci: run CUDA builds
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
GEOS Code Rules
Aims at writing down the coding standards for GEOS, focusing on type safety, error handling, parallelism, and performance. Key principles include:
These rules ensure code quality, consistency, and maintainability across the GEOS codebase.
This PR is before #3914