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.

Sign up for GitHub

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

Jump to bottom

Consistent spec titles #609

Merged
merged 2 commits into from
Dec 22, 2021
Merged

Consistent spec titles #609

merged 2 commits into from
Dec 22, 2021

Conversation

milancurcic
Copy link
Member

This PR:

  • Renames several spec title attributes to make them consistent with others (module names)
  • A few similar edits to the index.md of the Spec top-level page, for consistency.

Closes #608.

@milancurcic milancurcic requested a review from jvdp1 December 22, 2021 18:34
jvdp1
jvdp1 approved these changes Dec 22, 2021
View reviewed changes
Copy link
Member

@jvdp1 jvdp1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I approve this PR because it makes all titles using the same rule. However, I would prefer more explicit titles.

doc/specs/stdlib_hash_procedures.md
@@ -1,5 +1,5 @@
---
title: Hash procedures
title: hash
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually I would prefer reading Hash procedures over hash, which is more informative to me.
E..g., Numerical integration can be easier understood than quadrature.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why don't we choose whether to list descriptive names or module names and use it consistently? I assumed we were listing module names. Can we merge this as is, and I'll open a new issue to discuss whether to switch this table to descriptive names?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, merge it as is. At least it is consistent now. Thank you.

@milancurcic milancurcic merged commit 3bb004d into fortran-lang:master Dec 22, 2021
@milancurcic milancurcic deleted the consistent-spec-titles branch December 22, 2021 19:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jvdp1 jvdp1 jvdp1 approved these changes

@awvwgk awvwgk awvwgk approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Spec titles are not consistent in the rendered docs
3 participants
@milancurcic @jvdp1 @awvwgk