Skip to content

Commit bffedf6

Browse files
small typo/word choice/punctuation fixes on reading entire document (#368)
1 parent c2ca5f8 commit bffedf6

File tree

12 files changed

+23
-23
lines changed

12 files changed

+23
-23
lines changed

docs/docs/addition_subtraction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Addition and Subtraction
22

3-
To easily adding and subtracting time, you can use the `add()` and `subtract()`
3+
To easily add and subtract time, you can use the `add()` and `subtract()`
44
methods.
55
Each method returns a new `DateTime` instance.
66

docs/docs/fluent_helpers.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Fluent helpers
22

3-
Pendulum provides helpers that returns a new instance with some attributes
3+
Pendulum provides helpers that return a new instance with some attributes
44
modified compared to the original instance.
5-
However, none of these helpers, with the exception of explicitely setting the
5+
However, none of these helpers, with the exception of explicitly setting the
66
timezone, will change the timezone of the instance. Specifically,
77
setting the timestamp will not set the corresponding timezone to UTC.
88

@@ -38,8 +38,8 @@ You can also modify the timezone.
3838
>>> dt.set(tz='Europe/London')
3939
```
4040

41-
Setting the timezone just modify the timezone information without
42-
making any conversion while `in_timezone()` (or `in_tz()`)
41+
Setting the timezone just modifies the timezone information without
42+
making any conversion, while `in_timezone()` (or `in_tz()`)
4343
converts the time in the appropriate timezone.
4444

4545
```python

docs/docs/instantiation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ True
1616

1717
`datetime()` sets the time to `00:00:00` if it's not specified,
1818
and the timezone (the `tz` keyword argument) to `UTC`.
19-
It otherwise can be a `Timezone` instance or simply a string timezone value.
19+
Otherwise it can be a `Timezone` instance or simply a string timezone value.
2020

2121
```python
2222
>>> import pendulum
@@ -88,7 +88,7 @@ and each has their time value set to `00:00:00`.
8888
```
8989

9090
Pendulum enforces timezone aware datetimes, and using them is the preferred and recommended way
91-
of using the library, however is you really need a **naive** `DateTime` object, the `naive()` helper
91+
of using the library. However, if you really need a **naive** `DateTime` object, the `naive()` helper
9292
is there for you.
9393

9494
```python

docs/docs/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ It provides classes that are drop-in replacements for the native ones (they inhe
66

77
Special care has been taken to ensure timezones are handled correctly,
88
and are based on the underlying `tzinfo` implementation.
9-
For example all comparisons are done in `UTC` or in the timezone of the datetime being used.
9+
For example, all comparisons are done in `UTC` or in the timezone of the datetime being used.
1010

1111
```python
1212
>>> import pendulum

docs/docs/limitations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Here is a list (non-exhaustive) of the reported cases with a possible solution,
2424
pymysql.converters.conversions[pendulum.DateTime] = pymysql.converters.escape_datetime
2525
```
2626

27-
* `django` will use the `isoformat()` method to store datetimes in the database. However since `pendulum` is always timezone aware the offset information will always be returned by `isoformat()` raising an error, at least for MySQL databases. To work around it you can either create your own `DateTimeField` or use the previous workaround for `MySQLdb`:
27+
* `django` will use the `isoformat()` method to store datetimes in the database. However, since `pendulum` is always timezone aware, the offset information will always be returned by `isoformat()` raising an error, at least for MySQL databases. To work around it, you can either create your own `DateTimeField` or use the previous workaround for `MySQLdb`:
2828

2929
```python
3030
import pendulum

docs/docs/localization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ by using `pendulum.set_locale()`.
2626
```
2727

2828
However, you might not want to set the locale globally. The `diff_for_humans()`
29-
method accept a `locale` keyword argument to use a locale for a specific call.
29+
method accepts a `locale` keyword argument to use a locale for a specific call.
3030

3131
```python
3232
>>> pendulum.set_locale('de')

docs/docs/modifiers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Modifiers
22

3-
These group of methods perform helpful modifications to a copy of the current instance.
3+
This group of methods performs helpful modifications to a copy of the current instance.
44
You'll notice that the `start_of()`, `next()` and `previous()` methods
55
set the time to `00:00:00` and the `end_of()` methods set the time to `23:59:59.999999`.
66

docs/docs/parsing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ The library natively supports the RFC 3339 format, most ISO 8601 formats and som
1818
>>> dt = pendulum.parse('1975-05-21 22:00:00')
1919
```
2020

21-
If you pass a non-standard or more complicated string, it will raise an exception so it is advised to
21+
If you pass a non-standard or more complicated string, it will raise an exception, so it is advised to
2222
use the `from_format()` helper instead.
2323

24-
However, if you want the library to fallback on the [dateutil](https://dateutil.readthedocs.io) parser,
24+
However, if you want the library to fall back on the [dateutil](https://dateutil.readthedocs.io) parser,
2525
you have to pass `strict=False`.
2626

2727
```python

docs/docs/period.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Period
22

3-
When you subtract a `DateTime` instance to another, or use the `diff()` method, it will return a `Period` instance.
3+
When you subtract a `DateTime` instance from another, or use the `diff()` method, it will return a `Period` instance.
44
It inherits from the [Duration](#duration) class with the added benefit that it is aware of the
55
instances that generated it, so that it can give access to more methods and properties:
66

@@ -61,7 +61,7 @@ transitions that might have occurred and adjust accordingly. Let's take an examp
6161

6262
!!!warning
6363

64-
Due to its nature (fixed duration between two datetimes), most arithmetic operations will
64+
Due to their nature (fixed duration between two datetimes), most arithmetic operations will
6565
return a `Duration` instead of a `Period`.
6666

6767
```python
@@ -98,7 +98,7 @@ You can also make an inverted period:
9898
```
9999

100100
If you have inverted dates but want to make sure that the period is positive,
101-
you set the `absolute` keyword argument to `True`:
101+
you should set the `absolute` keyword argument to `True`:
102102

103103
```python
104104
>>> period = pendulum.period(end, start, absolute=True)

docs/docs/string_formatting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# String formatting
22

3-
The `__str__` magic method is defined which allows `DateTime` instances to be printed
3+
The `__str__` magic method is defined to allow `DateTime` instances to be printed
44
as a pretty date string when used in a string context.
55

66
The default string representation is the same as the one returned by the `isoformat()` method.

0 commit comments

Comments
 (0)