Skip to content

Commit 6b17435

Browse files
committed
More documentation improvements
1 parent 66f1266 commit 6b17435

File tree

3 files changed

+8
-6
lines changed

3 files changed

+8
-6
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ Very basic type casting can be enabled by:
146146
But Pg's type casting is highly customizable. That's why it's divided into
147147
2 layers:
148148

149-
### Encoders / Decoders (ext/pg_*coder.c, lib/pg/*coder.rb)
149+
### Encoders / Decoders (ext/pg_\*coder.c, lib/pg/\*coder.rb)
150150

151151
This is the lower layer, containing encoding classes that convert Ruby
152152
objects for transmission to the DBMS and decoding classes to convert
@@ -188,9 +188,9 @@ The following text and binary formats can also be encoded although they are not
188188
* Literal for insertion into SQL string: [TE](rdoc-ref:PG::TextEncoder::QuotedLiteral)
189189
* SQL-Identifier: [TE](rdoc-ref:PG::TextEncoder::Identifier), [TD](rdoc-ref:PG::TextDecoder::Identifier)
190190

191-
### PG::TypeMap and derivations (ext/pg_type_map*.c, lib/pg/type_map*.rb)
191+
### TypeMap and derivations (ext/pg_type_map\*.c, lib/pg/type_map\*.rb)
192192

193-
A TypeMap defines which value will be converted by which encoder/decoder.
193+
A PG::TypeMap defines which value will be converted by which encoder/decoder.
194194
There are different type map strategies, implemented by several derivations
195195
of this class. They can be chosen and configured according to the particular
196196
needs for type casting. The default type map is PG::TypeMapAllStrings.

ext/pg_result.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1402,7 +1402,7 @@ pgresult_fields(VALUE self)
14021402
* call-seq:
14031403
* res.type_map = typemap
14041404
*
1405-
* Set the TypeMap that is used for type casts of result values to ruby objects.
1405+
* Set the PG::TypeMap that is used for type casts of result values to ruby objects.
14061406
*
14071407
* All value retrieval methods will respect the type map and will do the
14081408
* type casts from PostgreSQL's wire format to Ruby objects on the fly,
@@ -1432,7 +1432,7 @@ pgresult_type_map_set(VALUE self, VALUE typemap)
14321432
* call-seq:
14331433
* res.type_map -> value
14341434
*
1435-
* Returns the TypeMap that is currently set for type casts of result values to ruby objects.
1435+
* Returns the PG::TypeMap that is currently set for type casts of result values to ruby objects.
14361436
*
14371437
*/
14381438
static VALUE

ext/pg_type_map.c

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,9 @@ init_pg_type_map(void)
187187
*
188188
* This is the base class for type maps.
189189
* See derived classes for implementations of different type cast strategies
190-
* ( PG::TypeMapByColumn, PG::TypeMapByOid ).
190+
* ( PG::TypeMapByColumn, PG::TypeMapByOid, etc.).
191+
*
192+
* Find more type maps in the {README}[rdoc-ref:README.md@Type+Casts].
191193
*
192194
*/
193195
rb_cTypeMap = rb_define_class_under( rb_mPG, "TypeMap", rb_cObject );

0 commit comments

Comments
 (0)