Skip to content

Commit dc11c3f

Browse files
docs: update function style and branch names
* Changes master to main in CONTRIBUTING.md * Claifies function return documentation in CODE_STYLE.md
1 parent 28e8e3e commit dc11c3f

File tree

2 files changed

+5
-7
lines changed

2 files changed

+5
-7
lines changed

CODE_STYLE.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@
4343
* Inline doxygen descriptions for all member variables.
4444

4545
## Functions
46-
* Functions should include a result variable on its own line, that does not have
47-
a specific intent.
46+
* If a function has a result variable, it should be declared on its own line,
47+
and the variable should not be declared with a specific intent.
4848
* Inline doxygen descriptions for all arguments, except the result variable.
4949
* Doxygen description on the line(s) before the function definition. This must
5050
specify what the function is returning using the `@return` doxygen keyword.
@@ -120,9 +120,7 @@ module example_mod
120120
121121
!> @brief Doxygen description
122122
!! @return Function return value.
123-
function func1(arg1, &
124-
& arg2) &
125-
& result(res)
123+
function func1(arg1, arg2) result(res)
126124
integer(kind=INT32),intent(in) :: arg1 !< Inline doxygen description
127125
integer(kind=INT32),intent(in) :: arg2 !< Inline doxygen description
128126
integer(kind=INT32) :: res

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,10 @@ uphold this code. Please report unacceptable behavior to
3535

3636
1. Create an issue that describes the change, or feature request
3737
2. Fork the project
38-
3. Create a feature branch off an up-do-date `master` branch
38+
3. Create a feature branch off an up-do-date `main` branch
3939
4. Update the tests and code
4040
5. Push the commits to your fork
41-
6. Submit a pull request to the `master` branch
41+
6. Submit a pull request to the `main` branch
4242

4343
## Support
4444

0 commit comments

Comments
 (0)