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

Don't repeat names of procedures in descriptions #794

Open
Beliavsky opened this issue Apr 12, 2024 · 0 comments
Open

Don't repeat names of procedures in descriptions #794

Beliavsky opened this issue Apr 12, 2024 · 0 comments

Comments

@Beliavsky
Copy link

Looking at https://stdlib.fortran-lang.org/lists/procedures.html, in most cases the descriptions do not repeat the name of the procedure. For example, the description for adjustl is "Left-adjust the character sequence represented by the string. The length of the character sequence remains unchanged." I think this is preferable.

In other cases, the description starts by repeating the name of the procedure, for example

"arange creates a one-dimensional array of the integer/real type with fixed-spaced values of given spacing, within a given interval."
"arg computes the phase angle in the interval (-π,π]."

To be concise and maintain a consistent style, I think the descriptions should be

"Creates a one-dimensional array of the integer/real type with fixed-spaced values of given spacing, within a given interval."
"Computes the phase angle in the interval (-π,π]."

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

No branches or pull requests

1 participant