Skip to content

Commit 7edd668

Browse files
committed
Added help text to README.md
1 parent 8924db0 commit 7edd668

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Output:
101101

102102
To get a mapcode for every territory in which a coordinate can be encoded, use
103103

104-
encodeShortest (lat, lon)
104+
encodeShortest(lat, lon)
105105

106106
Since any coordinate is somewhere on the world, this routine is guaranteed to deliver at least one possibility.
107107

@@ -116,9 +116,9 @@ Output using displayMapcodes(e):
116116
USA KKYP.19MN
117117
R59KJ.W5FT
118118

119-
This particular coordinate thus has a California mapcode (XX.XX), a national 8-letter mapcode,
119+
This particular coordinate thus has a California mapcode (`XX.XX`), a national 8-letter mapcode,
120120
and (like any coordinate) an international 9-letter mapcode (by tradition shown without its
121-
alphacode “AAA”).
121+
alphacode “`AAA`”).
122122

123123
### All Possible Mapcodes
124124

@@ -166,7 +166,7 @@ Output using `displayMapcodes(e)`:
166166
USA L70X.6V4G
167167
R5KDM.C8C8
168168

169-
Note that two of these (in US-CA) are politically incorrect, since the specified coordinate
169+
Note that two of these (in `US-CA`) are politically incorrect, since the specified coordinate
170170
lies within the borders of Nevada and not California. However, they are valid in that the
171171
mapcodes correctly represent the original coordinate.
172172

@@ -183,7 +183,7 @@ the coordinate.
183183

184184
A mapcode represents a coordinate with a precision of a few meters. To be precise,
185185
most mapcodes represent the center point of a 10x10 meter area. The coordinate may
186-
thus be 5 meters off both longitudinally and latitudinal, or 3,6 meters on average.
186+
thus be 5 meters off both longitudinally and latitudinal, or 3.6 meters on average.
187187
This is precise enough for everyday use, but mapcodes can also be generate with higher
188188
precisions. With one extra letter (after a hyphen), a mapcode represents a 2x2 meter area,
189189
with two letters, an area of a square foot. The extra letters defeat the purpose of the
@@ -210,7 +210,7 @@ Given a string with a mapcode (which may or may not include a territory alphacod
210210
parameter | description |
211211
--- | ---
212212
mapcodeString | a string containing a mapcode
213-
return value | an object with fields x (longitude) and y (latitude), or false
213+
return value | an object with fields `x` (longitude) and `y` (latitude), or false
214214

215215
This routine is sufficient to decode a full mapcodeString into a coordinate.
216216

@@ -238,7 +238,7 @@ parameter | description
238238
--- | ---
239239
mapcodeString | a string containing a mapcode
240240
contextTerritory | a string (an ISO code such as “NLD”)
241-
returns | an object with fields x (longitude) and y (latitude), or false
241+
return value | an object with fields `x` (longitude) and `y` (latitude), or false
242242

243243
By passing a context territory, you allow the decode routine to solve any ambiguities.
244244

@@ -281,28 +281,28 @@ India have mapcode `49.4V`).
281281

282282
parameter | description
283283
--- | ---
284-
territory | an string (an ISO code such as “NLD”)
284+
territory | an string (an ISO code such as “`NLD`”)
285285
return value | string (the full name of the territory)
286286

287287
isSubdivision(territory)
288288

289289
parameter | description
290290
--- | ---
291-
territory | an string (an ISO code such as “NLD”)
291+
territory | an string (an ISO code such as “`NLD`”)
292292
return value | true iff territory is a subdivision of a country
293293

294294
hasSubdivisions(territory)
295295

296296
parameter | description
297297
--- | ---
298-
territory | an string (an ISO code such as “NLD”)
298+
territory | an string (an ISO code such as “`NLD`”)
299299
return value | true iff territory is a country that has subdivisions
300300

301301
getTerritoryAlphaCode(territory, format)
302302

303303
parameter | description
304304
--- | ---
305-
territory | string, or internal integer between 0 and ccode_earth
305+
territory | string (or internal integer between 0 and `ccode_earth`)
306306
format | 0: leave out country for subdivisions
307307
. | undefined or 1: always return full abbreviation
308308
. | 2: leave out country for subdivisions unless this would make the abbreviation ambigious

0 commit comments

Comments
 (0)