Skip to content

Commit 7fe7cb6

Browse files
committed
some minor improvements in doc
1 parent 9a0a33a commit 7fe7cb6

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

doc/specs/stdlib_stringlist_type.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,25 @@
22
title: stringlist type
33
---
44

5-
# `stdlib_stringlist_type` module (1-D List of strings)
5+
# `stdlib_stringlist_type` module (1-D list of strings)
66

77
[TOC]
88

99
## Introduction
1010

1111
The `stdlib_stringlist_type` module provides with 2 derived types to deal with lists of strings.
12-
`stringlist_type` derived type represents a one-dimensional list of variable-length strings which is compatible with Fortran intrinsic character and `stringlist_index_type` derived type represents an index to access, modify the elements of a stringlist and insert strings to a stringlist.
12+
`stringlist_type` derived type represents one-dimensional list of variable-length strings (also referred as one-dimensional stringlist) which is compatible with Fortran intrinsic character and `stringlist_index_type` derived type represents an index to access, modify the elements of a stringlist, insert elements to a stringlist and much more.
1313

1414
## Derived types provided
1515

1616
<!-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -->
1717
### `stringlist_type` derived type
1818

19-
The `stringlist_type` derived type represents one-dimensional list of strings.
19+
The `stringlist_type` derived type represents one-dimensional list of strings (also referred as one-dimensional stringlist).
2020
The internal representation of the list is implementation dependent and is not visible to the user of the module.
2121

22+
Note: `stringlist` is an abstract concept which is expressed through the derived type `stringlist_type`.
23+
2224
#### Status
2325

2426
Experimental
@@ -30,7 +32,7 @@ Experimental
3032
An instance of the derived type `stringlist_index_type` represents either a forward index OR a backward index.
3133
The internal representation is implementation dependent and is not visible to the user of the module.
3234
`list_head` and `list_tail` are 2 special instances of this type representing the head and the tail of a stringlist respectively.
33-
An instance is independent of the `stringlist_type` it is used with and hence, an index can be used with multiple stringlists in the same program.
35+
An index is independent of the stringlist(or `stringlist_type`) it is used with and hence, an index can be used with multiple stringlists in the same program.
3436

3537
#### Status
3638

@@ -86,11 +88,11 @@ end program demo_fidx_bidx
8688
```
8789

8890
<!-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -->
89-
### Constructor for `stringlist_type`
91+
### Constructor for `stringlist_type`(or stringlist)
9092

9193
#### Description
9294

93-
No arguments given: Initializes an empty stringlist(a list containing no elements in it).
95+
No arguments given: Initializes an empty stringlist(a stringlist containing no elements in it).
9496

9597
With argument: Initializes a stringlist equivalent to the input array `array` i.e. a stringlist containing all elements of the input array `array` in the same order.
9698

@@ -389,7 +391,7 @@ a [[stdlib_stringlist_type(module):stringlist_type(type)]].
389391

390392
#### Result value
391393

392-
The result is a default logical scalar value.
394+
The result is a default `logical` scalar value.
393395

394396
#### Example
395397

@@ -459,7 +461,7 @@ a [[stdlib_stringlist_type(module):stringlist_type(type)]].
459461

460462
#### Result value
461463

462-
The result is a default logical scalar value.
464+
The result is a default `logical` scalar value.
463465

464466
#### Example
465467

@@ -501,7 +503,7 @@ end program demo_inequality_operator
501503

502504
#### Description
503505

504-
Concatenates left hand side (lhs) and right hand side (rhs).
506+
Returns the concatenated output of left hand side (lhs) and right hand side (rhs).
505507

506508
#### Syntax
507509

0 commit comments

Comments
 (0)