Skip to content

Commit a9bc9a5

Browse files
committed
Improve documentation style
1 parent 24bbe90 commit a9bc9a5

File tree

2 files changed

+17
-13
lines changed

2 files changed

+17
-13
lines changed

API.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# The Map
1+
# Map
22

33
The map is, of course, the central element of most mapping sites. In the MapBox JavaScript API,
44
the map object manages a set of layers, stores and displays zoom levels and centerpoints,
@@ -239,7 +239,7 @@ _Arguments:_
239239

240240
_Returns_ and instance of `MM.Location`.
241241

242-
<div class="separator">Layer Management</div>
242+
<div class="separator">Layer management</div>
243243

244244
### map.addLayer(layer)
245245

@@ -340,7 +340,7 @@ _Arguments_
340340

341341
_Returns_ a layer.
342342

343-
<div class="separator">UI Controls</div>
343+
<div class="separator">User interface</div>
344344

345345
### map.ui
346346

@@ -633,7 +633,7 @@ _Returns_ `undefined`: this is an asynchronous function without a useful return
633633
mapbox.auto('map', 'http://a.tiles.mapbox.com/v3/tmcw.map-hehqnmda.jsonp');
634634
</script>
635635

636-
# MapBox Layer
636+
# Layer
637637

638638
`mapbox.layer` is a fast way to add layers to your map without having to deal with complex configuration.
639639

STYLE.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
By default, mapbox.js provides styled map controls. If you would like to override any of these
2-
elements this section covers the default markup and css. Alter any of these styles in your own css
2+
elements this section covers the default markup and CSS. Alter any of these styles in your own css
33
that follows after `mapbox.css`
44

55
## General
@@ -15,9 +15,12 @@ UI elements by default also share some of the same css:
1515
display:block;
1616
}
1717

18-
__Note for IE7 users:__ `mapbox.css` uses a [Data URI](http://en.wikipedia.org/wiki/Data_URI_scheme) as its source for images which is not supported in versions less than IE8. To support these users you can link directly to a [cdn hosted version of the image](http://api.tiles.mapbox.com/mapbox.js/v0.5.5/map-controls.png) in your css.
18+
__Note for Internet Explorer 7 users:__ `mapbox.css` uses a
19+
[Data URI](http://en.wikipedia.org/wiki/Data_URI_scheme) as its source
20+
for images which is not supported in versions less than Internet Explorer 8.
21+
To support these users you can link directly to a [CDN hosted version of the image](http://api.tiles.mapbox.com/mapbox.js/v0.5.5/map-controls.png) in your css.
1922

20-
Other elments like legends, tooltips along with ui controls share the same css:
23+
Other elements like legends, tooltips along with ui controls share the same css:
2124

2225
.zoomer,
2326
.map-legends,
@@ -31,7 +34,7 @@ Other elments like legends, tooltips along with ui controls share the same css:
3134
border-radius:3px;
3235
}
3336

34-
## Zoom Controls
37+
## Zoom controls
3538

3639
__Markup__
3740

@@ -68,7 +71,7 @@ __Default css__
6871
box-shadow:inset 0 1px 3px rgba(0,0,0,0.15);
6972
}
7073

71-
When a zoom control is out of range a class name of `.zoomdisabled` The following css applied:
74+
When a zoom control is out of range a class name of `.zoomdisabled` The following CSS applied:
7275

7376
.zoomdisabled {
7477
background-color:#eee;
@@ -101,9 +104,9 @@ __Default css__
101104
user-select:auto;
102105
}
103106

104-
An optional classname of `.map-fade` is added to `.map-tooltip` when you initially mouse over/out on an element.
107+
An optional className of `.map-fade` is added to `.map-tooltip` when you initially mouse over/out on an element.
105108
This is added when animation is set to true. This additional class provides an easy way to apply fading animation
106-
using css. The default styling look like this:
109+
using CSS. The default styling look like this:
107110

108111
.map-tooltip {
109112
opacity:1;
@@ -112,7 +115,7 @@ using css. The default styling look like this:
112115
}
113116
.map-fade { opacity:0; }
114117

115-
When a tooltip has the interaction of a full formatter a close elemtent is applied:
118+
When a tooltip has the interaction of a full formatter a close element is applied:
116119

117120
__Markup__
118121

@@ -221,7 +224,8 @@ __Default css__
221224

222225
## Retina screens
223226

224-
To support screens a media query is provided with an alternate scaled up version of the image sprite for the controls:
227+
To support screens a [media query](http://www.w3.org/TR/css3-mediaqueries/) is provided
228+
with an alternate scaled-up version of the image sprite for the controls:
225229

226230
@media
227231
only screen and (-webkit-min-device-pixel-ratio : 2),

0 commit comments

Comments
 (0)