Skip to content

Commit e76508d

Browse files
Minor documentation fixes
1 parent 39e0e96 commit e76508d

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,14 @@ In your own stamp you will probably implement only extract methods you need, eit
7171
Amount of data that can be consumed by Stamp is called Stamp Size.
7272
Depending on Min Stamp Size and Max Stamp Size, Stamps cam be divided into three groups:
7373

74-
* *Fixed Size Stamps*: Stamp consumes fixed amount of data (Min Stamp Size == Max Stamp Size).
74+
* **Fixed Size Stamps**: Stamp consumes fixed amount of data (Min Stamp Size == Max Stamp Size).
7575
For example `StampArithm<T>` stamp always consumes `sizeof(T)` bytes.
7676

77-
* *Variated Size Stamp*: Min Stamp Size != Max Stamp Size.
77+
* **Variated Size Stamp**: Min Stamp Size != Max Stamp Size.
7878
For example stamp that generates string with random Latin letters 3 to 16 character long.
7979
It consumes 3..16 bytes and "normalizes" them to Latin character bytes.
8080

81-
* *Unbounded Size Stamp*: Stamp that has Min Size, but will consume any amount of data if provided.
81+
* **Unbounded Size Stamp**: Stamp that has Min Size, but will consume any amount of data if provided.
8282

8383
Min and Max Stamp Sizes are available via `minSize()` and `maxSize()` methods.
8484
For Unbound Size Stamps `maxSize()` is set to `-1`.
@@ -319,10 +319,10 @@ class ArrayOfComplexIntStamp: public GalleyVectorStr, public StampBaseStr
319319
virtual std::string ExtractStr(Blob &blob) override;
320320
};
321321
```
322-
Because of order initialization issue, we have to initialize the stamp inside the call of parent class constructor via `new` method, and then destroy in in the destructor.
322+
Because of initialization order issue, we have to initialize the stamp inside the call of parent class constructor via `new` method, and then destroy in in the destructor.
323323

324324
Here do not need to implement `maxSize()` and `maxSize()`, as Galley properly implements them for us.
325-
So we need only to implement Extract method we need.
325+
We implement only the Extract method we need.
326326

327327

328328
```
@@ -425,13 +425,11 @@ Code is quite clear (I hope), except for the code of Galley, that are a bit intr
425425
3. Read tests.
426426
Tests are located in `t` directory.
427427
Much effort were put into covering all LibBlobStamper functionality with tests.
428-
So if some functionality is not covered with this README, or with standalone examples,
429-
you can find examples of usage in the tests.
428+
So if some functionality is not covered with this README, or with standalone examples, you can find examples of usage in the tests.
430429

431430
## Authors
432431

433-
LibBlobStamper were created by Nikolay Shaplov from Postgres Porfessional at
434-
2021-2022.
432+
LibBlobStamper were created by Nikolay Shaplov from Postgres Porfessional in 2021-2022.
435433

436434
You can contact me via e-mail: `[email protected]` or via matrix: `@n.shaplov:postgrespro.ru`.
437435
E-mail lists and chat rooms will be created when they are needed.

0 commit comments

Comments
 (0)