Skip to content

Commit e3b4c87

Browse files
committed
docs: proofread README
1 parent 47b0a5b commit e3b4c87

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.rst

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@ puremagic
33
=========
44

55
puremagic is a pure python module that will identify a file based off
6-
it's magic numbers.
6+
its magic numbers.
77

88
It is designed to be minimalistic and inherently cross platform
9-
compatible. It is also designed to be a stand in for python-magic, it
10-
incorporates the functions from\_file(filename[, mime]) and
11-
from\_string(string[, mime]) however the magic\_file() and
12-
magic\_string() are more powerful and will also display confidence and
9+
compatible. It is also designed to be a stand in for python-magic. It
10+
implements the functions :code:`from_file(filename[, mime])` and
11+
:code:`from_string(string[, mime])` however the :code:`magic_file()` and
12+
:code:`magic_string()` are more powerful and will also display confidence and
1313
duplicate matches.
1414

15-
It does NOT try to match files off non-magic string. In other words it
15+
It does NOT try to match files off non-magic string. In other words, it
1616
will not search for a string within a certain window of bytes like
1717
others might.
1818

@@ -40,16 +40,16 @@ For use with with 3.7 use the 1.x branch.
4040

4141
Using github ci to run continuous integration tests on listed platforms.
4242

43-
Install from pypy
43+
Install from PyPI
4444
-----------------
4545

46-
.. code:: bash
46+
.. :code:: bash
4747
4848
$ pip install puremagic
4949
5050
On linux environments, you may want to be clear you are using python3
5151

52-
.. code:: bash
52+
.. :code:: bash
5353
5454
$ python3 -m pip install puremagic
5555
@@ -59,7 +59,7 @@ Install from source
5959

6060
In either a virtualenv or globally, simply run:
6161

62-
.. code:: bash
62+
.. :code:: bash
6363
6464
$ python setup.py install
6565
@@ -69,7 +69,7 @@ Usage
6969
"from_file" will return the most likely file extension. "magic_file"
7070
will give you every possible result it finds, as well as the confidence.
7171

72-
.. code:: python
72+
.. :code:: python
7373
7474
import puremagic
7575
@@ -98,7 +98,7 @@ If you already have a file open, or raw byte string, you could also use:
9898
* magic_string
9999
* magic_stream
100100

101-
.. code:: python
101+
.. :code:: python
102102
103103
with open(r"test\resources\video\test.mp4", "rb") as file:
104104
print(puremagic.magic_stream(file))
@@ -111,13 +111,13 @@ Script
111111

112112
*Usage*
113113

114-
.. code:: bash
114+
.. :code:: bash
115115
116116
$ python -m puremagic [options] filename <filename2>...
117117
118118
*Examples*
119119

120-
.. code:: bash
120+
.. :code:: bash
121121
122122
$ python -m puremagic test/resources/images/test.gif
123123
'test/resources/images/test.gif' : .gif
@@ -131,7 +131,7 @@ imghdr replacement
131131

132132
If you are looking for a replacement for the standard library's depreciated imghdr, you can use `puremagic.what()`
133133

134-
.. code:: python
134+
.. :code:: python
135135
136136
import puremagic
137137

0 commit comments

Comments
 (0)