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

Consistent spec titles #609

Merged
merged 2 commits into from
Dec 22, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/specs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ This is and index/directory of the specifications (specs) for each new module/fe
- [ascii](./stdlib_ascii.html) - Procedures for handling ASCII characters
- [bitsets](./stdlib_bitsets.html) - Bitset data types and procedures
- [error](./stdlib_error.html) - Catching and handling errors
- [hash\_procedures](./stdlib_hash_procedures.html) - Hashing integer
- [hash](./stdlib_hash_procedures.html) - Hashing integer
vectors or character strings
- [IO](./stdlib_io.html) - Input/output helper & convenience
- [io](./stdlib_io.html) - Input/output helper & convenience
- [kinds](./stdlib_kinds.html) - Kind parameters
- [linalg](./stdlib_linalg.html) - Linear Algebra
- [logger](./stdlib_logger.html) - Runtime logging system
Expand All @@ -30,8 +30,8 @@ This is and index/directory of the specifications (specs) for each new module/fe
- [stats_distributions_uniform](./stdlib_stats_distribution_uniform.html) - Uniform Probability Distribution
- [stats_distributions_normal](./stdlib_stats_distribution_normal.html) - Normal Probability Distribution
- [string\_type](./stdlib_string_type.html) - Basic string support
- [strings](./stdlib_strings.html) - String handling and manipulation routines
- [stringlist_type](./stdlib_stringlist_type.html) - 1-Dimensional list of strings
- [strings](./stdlib_strings.html) - String handling and manipulation routines
- [version](./stdlib_version.html) - Version information

## Released/Stable Features & Modules
Expand Down
4 changes: 2 additions & 2 deletions doc/specs/stdlib_ascii.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: ASCII
title: ascii
---

# The `stdlib_ascii` module
Expand Down Expand Up @@ -212,4 +212,4 @@ program demo_reverse
implicit none
print'(a)', reverse("Hello, World!") ! returns "!dlroW ,olleH"
end program demo_reverse
```
```
2 changes: 1 addition & 1 deletion doc/specs/stdlib_bitsets.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Bitsets
title: bitsets
---

# The `stdlib_bitsets` module
Expand Down
2 changes: 1 addition & 1 deletion doc/specs/stdlib_hash_procedures.md
Original file line number Diff line number Diff line change
@@ -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.

---

# The `stdlib_hash_32bit` and `stdlib_hash_64bit` modules
Expand Down
2 changes: 1 addition & 1 deletion doc/specs/stdlib_io.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: IO
title: io
---

# IO
Expand Down
2 changes: 1 addition & 1 deletion doc/specs/stdlib_random.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: stats_random
title: random
---

# Statistical Distributions -- Pseudorandom Number Generator Module
Expand Down
2 changes: 1 addition & 1 deletion doc/specs/stdlib_selection.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Selection Procedures
title: selection
---

# The `stdlib_selection` module
Expand Down
2 changes: 1 addition & 1 deletion doc/specs/stdlib_sorting.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Sorting Procedures
title: sorting
---

# The `stdlib_sorting` module
Expand Down
2 changes: 1 addition & 1 deletion doc/specs/stdlib_string_type.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: string type
title: string_type
---

# The `stdlib_string_type` module
Expand Down
2 changes: 1 addition & 1 deletion doc/specs/stdlib_stringlist_type.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: stringlist type
title: stringlist_type
---

# `stdlib_stringlist_type` module (1-D list of strings)
Expand Down
4 changes: 2 additions & 2 deletions doc/specs/stdlib_strings.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: string handling
title: strings
---

# The `stdlib_strings` module
Expand Down Expand Up @@ -606,4 +606,4 @@ program demo_to_string
!! 1 wrong demonstrations(`[*]` from `to_string`)
end program demo_to_string
```
```
2 changes: 1 addition & 1 deletion doc/specs/stdlib_version.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Version information
title: version
---

# The `stdlib_version` module
Expand Down