Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Replace "eg" by "e.g." or "for example"
  • Loading branch information
DelazJ committed Dec 29, 2016
1 parent 5e87155 commit ef85cdc
Show file tree
Hide file tree
Showing 194 changed files with 405 additions and 404 deletions.
4 changes: 2 additions & 2 deletions INSTALL
Expand Up @@ -87,7 +87,7 @@ source directory.
2. Overview
===========

QGIS, like a number of major projects (eg. KDE 4.0), uses CMake
QGIS, like a number of major projects (e.g., KDE 4.0), uses CMake
(http://www.cmake.org) for building from source.

Following a summary of the required dependencies for building:
Expand Down Expand Up @@ -125,7 +125,7 @@ Optional dependencies:

Indirect dependencies:

Some proprietary formats (eg. ECW and MrSid) supported by GDAL require
Some proprietary formats (e.g., ECW and MrSid) supported by GDAL require
proprietary third party libraries. QGIS doesn't need any of those itself to
build, but will only support those formats if GDAL is built accordingly. Refer
to http://gdal.org/formats_list.html ff. for instructions how to include
Expand Down
4 changes: 2 additions & 2 deletions NEWS
Expand Up @@ -94,7 +94,7 @@ This release has following new features:
- Map Composer: Parameterized svg support for composer svg images
- Map Composer: Easier use of HTML in labels
- Map Composer: Relative links in composer labels
- Map Composer: Georeference outputs (eg PDF) from composer
- Map Composer: Georeference outputs (e.g., PDF) from composer
- Map Composer: Composer maps now auto-update with presets
- Analysis tools: Named parameters in expressions
- Analysis tools: More distance units
Expand Down Expand Up @@ -814,7 +814,7 @@ changed so we will just provide a bullet list of key new features here.

- Optionally re-use entered attribute values for next digitized feature.
- Allow merging/assigning attribute values to a set of features.-
- Allow OGR 'save as' without attributes (for eg. DGN/DXF).
- Allow OGR 'save as' without attributes (e.g., DGN/DXF).


14.7. Api and Developer Centric
Expand Down
4 changes: 2 additions & 2 deletions doc/INSTALL.html
Expand Up @@ -186,7 +186,7 @@ <H1>1. Introduction</H1>
<H1>2. Overview</H1>

<P>
QGIS, like a number of major projects (eg. KDE 4.0), uses CMake
QGIS, like a number of major projects (e.g., KDE 4.0), uses CMake
(<A HREF="http://www.cmake.org">http://www.cmake.org</A>) for building from source.
</P>
<P>
Expand Down Expand Up @@ -239,7 +239,7 @@ <H1>2. Overview</H1>
Indirect dependencies:
</P>
<P>
Some proprietary formats (eg. ECW and MrSid) supported by GDAL require
Some proprietary formats (e.g., ECW and MrSid) supported by GDAL require
proprietary third party libraries. QGIS doesn't need any of those itself to
build, but will only support those formats if GDAL is built accordingly. Refer
to <A HREF="http://gdal.org/formats_list.html">http://gdal.org/formats_list.html</A> ff. for instructions how to include
Expand Down
4 changes: 2 additions & 2 deletions doc/news.html
Expand Up @@ -174,7 +174,7 @@ <H1>1. What's new in Version 2.16 'Nødebo'?</H1>
<LI>Map Composer: Parameterized svg support for composer svg images
<LI>Map Composer: Easier use of HTML in labels
<LI>Map Composer: Relative links in composer labels
<LI>Map Composer: Georeference outputs (eg PDF) from composer
<LI>Map Composer: Georeference outputs (e.g., PDF) from composer
<LI>Map Composer: Composer maps now auto-update with presets
<LI>Analysis tools: Named parameters in expressions
<LI>Analysis tools: More distance units
Expand Down Expand Up @@ -935,7 +935,7 @@ <H2>14.6. Providers and Data Handling</H2>
<UL>
<LI>Optionally re-use entered attribute values for next digitized feature.
<LI>Allow merging/assigning attribute values to a set of features.-
<LI>Allow OGR 'save as' without attributes (for eg. DGN/DXF).
<LI>Allow OGR 'save as' without attributes (e.g., DGN/DXF).
</UL>
</UL>

Expand Down
2 changes: 1 addition & 1 deletion doc/news.t2t
Expand Up @@ -795,7 +795,7 @@ changed so we will just provide a bullet list of key new features here.

- Optionally re-use entered attribute values for next digitized feature.
- Allow merging/assigning attribute values to a set of features.-
- Allow OGR 'save as' without attributes (for eg. DGN/DXF).
- Allow OGR 'save as' without attributes (e.g., DGN/DXF).
-
-

Expand Down
4 changes: 2 additions & 2 deletions doc/overview.t2t
@@ -1,7 +1,7 @@

= Overview =

QGIS, like a number of major projects (eg. KDE 4.0), uses CMake
QGIS, like a number of major projects (e.g., KDE 4.0), uses CMake
(http://www.cmake.org) for building from source.

Following a summary of the required dependencies for building:
Expand Down Expand Up @@ -45,7 +45,7 @@ Optional dependencies:

Indirect dependencies:

Some proprietary formats (eg. ECW and MrSid) supported by GDAL require
Some proprietary formats (e.g., ECW and MrSid) supported by GDAL require
proprietary third party libraries. QGIS doesn't need any of those itself to
build, but will only support those formats if GDAL is built accordingly. Refer
to http://gdal.org/formats_list.html ff. for instructions how to include
Expand Down
2 changes: 1 addition & 1 deletion python/core/composer/qgscomposerattributetablev2.sip
Expand Up @@ -76,7 +76,7 @@ class QgsComposerAttributeTableV2 : QgsComposerTableV2
*/
ContentSource source() const;

/** Returns the source layer for the table, considering the table source mode. Eg,
/** Returns the source layer for the table, considering the table source mode. For example,
* if the table is set to atlas feature mode, then the source layer will be the
* atlas coverage layer. If the table is set to layer attributes mode, then
* the source layer will be the user specified vector layer.
Expand Down
6 changes: 3 additions & 3 deletions python/core/composer/qgscomposeritem.sip
Expand Up @@ -416,15 +416,15 @@ class QgsComposerItem : QgsComposerObject, QGraphicsRectItem
*/
void setTransparency( const int transparency );

/** Returns whether effects (eg blend modes) are enabled for the item
/** Returns whether effects (e.g., blend modes) are enabled for the item
* @returns true if effects are enabled
* @see setEffectsEnabled
* @see transparency
* @see blendMode
*/
bool effectsEnabled() const;

/** Sets whether effects (eg blend modes) are enabled for the item
/** Sets whether effects (e.g., blend modes) are enabled for the item
* @param effectsEnabled set to true to enable effects
* @see effectsEnabled
* @see setTransparency
Expand Down Expand Up @@ -508,7 +508,7 @@ class QgsComposerItem : QgsComposerObject, QGraphicsRectItem
/** Sets visibility for item.
* @param visible set to true to show item, false to hide item
* @note QGraphicsItem::setVisible should not be called directly
* on a QgsComposerItem, as some item types (eg groups) need to override
* on a QgsComposerItem, as some item types (e.g., groups) need to override
* the visibility toggle.
* @note added in version 2.5
*/
Expand Down
2 changes: 1 addition & 1 deletion python/core/composer/qgscomposermapitem.sip
@@ -1,6 +1,6 @@
/** \ingroup core
* \class QgsComposerMapItem
* \brief An item which is drawn inside a QgsComposerMap, eg a grid or map overview.
* \brief An item which is drawn inside a QgsComposerMap, e.g., a grid or map overview.
*/
class QgsComposerMapItem : QgsComposerObject
{
Expand Down
2 changes: 1 addition & 1 deletion python/core/composer/qgscomposermultiframe.sip
Expand Up @@ -205,7 +205,7 @@ class QgsComposerMultiFrame: QgsComposerObject

/** Creates a new frame and adds it to the multi frame and composition.
* @param currentFrame an existing QgsComposerFrame from which to copy the size
* and general frame properties (eg frame style, background, rendering settings).
* and general frame properties (e.g., frame style, background, rendering settings).
* @param pos position of top-left corner of the new frame
* @param size size of the new frame
* @returns new QgsComposerFrame
Expand Down
2 changes: 1 addition & 1 deletion python/core/composer/qgscomposition.sip
Expand Up @@ -732,7 +732,7 @@ class QgsComposition : QGraphicsScene, QgsExpressionContextGenerator

/** Calculates the bounds of all non-gui items in the composition. Ignores snap lines and mouse handles.
* @param ignorePages set to true to ignore page items
* @param margin optional marginal (in percent, eg 0.05 = 5% ) to add around items
* @param margin optional marginal (in percent, e.g., 0.05 = 5% ) to add around items
*/
QRectF compositionBounds( bool ignorePages = false, double margin = 0.0 ) const;

Expand Down
2 changes: 1 addition & 1 deletion python/core/effects/qgscoloreffect.sip
@@ -1,6 +1,6 @@
/** \ingroup core
* \class QgsColorEffect
* \brief A paint effect which alters the colors (eg brightness, contrast) in a
* \brief A paint effect which alters the colors (e.g., brightness, contrast) in a
* source picture.
*
* \note Added in version 2.9
Expand Down
2 changes: 1 addition & 1 deletion python/core/geometry/qgsabstractgeometry.sip
Expand Up @@ -398,7 +398,7 @@ class QgsAbstractGeometry
*/
virtual QgsRectangle calculateBoundingBox() const;

/** Clears any cached parameters associated with the geometry, eg bounding boxes
/** Clears any cached parameters associated with the geometry, e.g., bounding boxes
*/
virtual void clearCache() const;
};
4 changes: 2 additions & 2 deletions python/core/geometry/qgsgeometry.sip
Expand Up @@ -551,7 +551,7 @@ class QgsGeometry

/**
* Returns a point guaranteed to lie on the surface of a geometry. While the centroid()
* of a geometry may be located outside of the geometry itself (eg for concave shapes),
* of a geometry may be located outside of the geometry itself (e.g., for concave shapes),
* the point on surface will always be inside the geometry.
* @see centroid()
* @see poleOfInaccessibility()
Expand Down Expand Up @@ -892,7 +892,7 @@ class QgsGeometry
* @param iterations number of smoothing iterations to run. More iterations results
* in a smoother geometry
* @param offset fraction of line to create new vertices along, between 0 and 1.0
* eg the default value of 0.25 will create new vertices 25% and 75% along each line segment
* For example, the default value of 0.25 will create new vertices 25% and 75% along each line segment
* of the geometry for each iteration. Smaller values result in "tighter" smoothing.
* @param minimumDistance minimum segment length to apply smoothing to
* @param maxAngle maximum angle at node (0-180) at which smoothing will be applied
Expand Down
10 changes: 5 additions & 5 deletions python/core/geometry/qgspointv2.sip
Expand Up @@ -25,7 +25,7 @@ class QgsPointV2: public QgsAbstractGeometry
*/
explicit QgsPointV2( QPointF p );

/** Construct a point with a specified type (eg PointZ, PointM) and initial x, y, z, and m values.
/** Construct a point with a specified type (e.g., PointZ, PointM) and initial x, y, z, and m values.
* @param type point type
* @param x x-coordinate of point
* @param y y-coordinate of point
Expand Down Expand Up @@ -140,17 +140,17 @@ class QgsPointV2: public QgsAbstractGeometry

/**
* Returns the distance between this point and a specified x, y coordinate. In certain
* cases it may be more appropriate to call the faster distanceSquared() method, eg
* when comparing distances.
* cases it may be more appropriate to call the faster distanceSquared() method,
* e.g., when comparing distances.
* @note added in QGIS 3.0
* @see distanceSquared()
*/
double distance( double x, double y ) const;

/**
* Returns the 2D distance between this point and another point. In certain
* cases it may be more appropriate to call the faster distanceSquared() method, eg
* when comparing distances.
* cases it may be more appropriate to call the faster distanceSquared() method,
* e.g., when comparing distances.
* @note added in QGIS 3.0
*/
double distance( const QgsPointV2& other ) const;
Expand Down
10 changes: 5 additions & 5 deletions python/core/geometry/qgswkbtypes.sip
Expand Up @@ -75,22 +75,22 @@ class QgsWkbTypes
NullGeometry
};

/** Returns the single type for a WKB type. Eg, for MultiPolygon WKB types the single type would be Polygon.
/** Returns the single type for a WKB type. For example, for MultiPolygon WKB types the single type would be Polygon.
* @see isSingleType()
* @see multiType()
* @see flatType()
*/
static Type singleType( Type type );

/** Returns the multi type for a WKB type. Eg, for Polygon WKB types the multi type would be MultiPolygon.
/** Returns the multi type for a WKB type. For example, for Polygon WKB types the multi type would be MultiPolygon.
* @see isMultiType()
* @see singleType()
* @see flatType()
*/
static Type multiType( Type type );

/** Returns the flat type for a WKB type. This is the WKB type minus any Z or M dimensions.
* Eg, for PolygonZM WKB types the single type would be Polygon.
* For example, for PolygonZM WKB types the single type would be Polygon.
* @see singleType()
* @see multiType()
*/
Expand Down Expand Up @@ -137,12 +137,12 @@ class QgsWkbTypes
*/
static int coordDimensions( Type type );

/** Returns the geometry type for a WKB type, eg both MultiPolygon and CurvePolygon would have a
/** Returns the geometry type for a WKB type, e.g., both MultiPolygon and CurvePolygon would have a
* PolygonGeometry geometry type.
*/
static GeometryType geometryType( Type type );

/** Returns a display string type for a WKB type, eg the geometry name used in WKT geometry representations.
/** Returns a display string type for a WKB type, e.g., the geometry name used in WKT geometry representations.
*/
static QString displayString( Type type );

Expand Down
4 changes: 2 additions & 2 deletions python/core/qgis.sip
Expand Up @@ -104,7 +104,7 @@ class Qgis
static double SCALE_PRECISION;
};

/** Converts a string to a double in a permissive way, eg allowing for incorrect
/** Converts a string to a double in a permissive way, e.g., allowing for incorrect
* numbers of digits between thousand separators
* @param string string to convert
* @param ok will be set to true if conversion was successful
Expand All @@ -114,7 +114,7 @@ class Qgis
*/
double qgsPermissiveToDouble( QString string, bool& ok );

/** Converts a string to an integer in a permissive way, eg allowing for incorrect
/** Converts a string to an integer in a permissive way, e.g., allowing for incorrect
* numbers of digits between thousand separators
* @param string string to convert
* @param ok will be set to true if conversion was successful
Expand Down
2 changes: 1 addition & 1 deletion python/core/qgsapplication.sip
Expand Up @@ -248,7 +248,7 @@ static void qtgui_UpdatePyArgv(PyObject *argvlist, int argc, char **argv)
*/
static QString osName();

/** Returns the QGIS platform name, eg "desktop" or "server".
/** Returns the QGIS platform name, e.g., "desktop" or "server".
* @note added in QGIS 2.14
* @see osName()
*/
Expand Down
4 changes: 2 additions & 2 deletions python/core/qgscolorramp.sip
Expand Up @@ -183,12 +183,12 @@ class QgsGradientColorRamp : QgsColorRamp
*/
QgsGradientStopsList stops() const;

/** Returns any additional info attached to the gradient ramp (eg authorship notes)
/** Returns any additional info attached to the gradient ramp (e.g., authorship notes)
* @see setInfo()
*/
QgsStringMap info() const;

/** Sets additional info to attach to the gradient ramp (eg authorship notes)
/** Sets additional info to attach to the gradient ramp (e.g., authorship notes)
* @param info map of string info to attach
* @see info()
*/
Expand Down
10 changes: 5 additions & 5 deletions python/core/qgscoordinatereferencesystem.sip
Expand Up @@ -186,7 +186,7 @@ class QgsCoordinateReferenceSystem
// static creators

/** Creates a CRS from a given OGC WMS-format Coordinate Reference System string.
* @param ogcCrs OGR compliant CRS definition, eg "EPSG:4326"
* @param ogcCrs OGR compliant CRS definition, e.g., "EPSG:4326"
* @returns matching CRS, or an invalid CRS if string could not be matched
* @note added in QGIS 3.0
* @see createFromOgcWmsCrs()
Expand Down Expand Up @@ -416,9 +416,9 @@ class QgsCoordinateReferenceSystem

/** Returns the authority identifier for the CRS.
*
* The identifier includes both the authority (eg EPSG) and the CRS number (eg 4326).
* The identifier includes both the authority (e.g., EPSG) and the CRS number (e.g., 4326).
* This is the best method to use when showing a very short CRS identifier to a user,
* eg "EPSG:4326".
* e.g., "EPSG:4326".
*
* If CRS object is a custom CRS (not found in database), the method will return
* internal QGIS CRS ID with "QGIS" authority, for example "QGIS:100005"
Expand All @@ -427,7 +427,7 @@ class QgsCoordinateReferenceSystem
*/
QString authid() const;

/** Returns the descriptive name of the CRS, eg "WGS 84" or "GDA 94 / Vicgrid94". In most
/** Returns the descriptive name of the CRS, e.g., "WGS 84" or "GDA 94 / Vicgrid94". In most
* cases this is the best method to use when showing a friendly identifier for the CRS to a
* user.
* @returns descriptive name of the CRS
Expand Down Expand Up @@ -472,7 +472,7 @@ class QgsCoordinateReferenceSystem
*/
bool isGeographic() const;

/** Returns whether axis is inverted (eg. for WMS 1.3) for the CRS.
/** Returns whether axis is inverted (e.g., for WMS 1.3) for the CRS.
* @returns true if CRS axis is inverted
*/
bool hasAxisInverted() const;
Expand Down
4 changes: 2 additions & 2 deletions python/core/qgsdatetimestatisticalsummary.sip
Expand Up @@ -37,13 +37,13 @@ class QgsDateTimeStatisticalSummary
QgsDateTimeStatisticalSummary( QgsDateTimeStatisticalSummary::Statistics stats = All );

/** Returns flags which specify which statistics will be calculated. Some statistics
* are always calculated (eg count).
* are always calculated (e.g., count).
* @see setStatistics
*/
Statistics statistics() const;

/** Sets flags which specify which statistics will be calculated. Some statistics
* are always calculated (eg count).
* are always calculated (e.g., count).
* @param stats flags for statistics to calculate
* @see statistics
*/
Expand Down
4 changes: 2 additions & 2 deletions python/core/qgsdistancearea.sip
Expand Up @@ -167,7 +167,7 @@ class QgsDistanceArea
* @param distance distance to format
* @param decimals number of decimal places to show
* @param unit unit of distance
* @param keepBaseUnit set to false to allow conversion of large distances to more suitable units, eg meters to
* @param keepBaseUnit set to false to allow conversion of large distances to more suitable units, e.g., meters to
* kilometers
* @returns formatted distance string
* @note added in QGIS 2.16
Expand All @@ -179,7 +179,7 @@ class QgsDistanceArea
* @param area area to format
* @param decimals number of decimal places to show
* @param unit unit of area
* @param keepBaseUnit set to false to allow conversion of large areas to more suitable units, eg square meters to
* @param keepBaseUnit set to false to allow conversion of large areas to more suitable units, e.g., square meters to
* square kilometers
* @returns formatted area string
* @note added in QGIS 2.14
Expand Down

0 comments on commit ef85cdc

Please sign in to comment.