Skip to content

Commit e838de3

Browse files
author
Derick Alangi
authoredMay 29, 2021
[skip-ci] Improve documentation for better clarity to readers (php#7066)
While reading the docs in the repo, I found & made a few improvements to the documentation so it's clearer to its readers. These improvements are around: typos, general punctuations, and grammar.
1 parent 2454e3b commit e838de3

6 files changed

+21
-21
lines changed
 

‎docs/mailinglist-rules.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
# Mailinglist rules
1+
# Mailing list rules
22

33
This is the first file you should be reading before doing any posts on PHP
4-
mailinglists. Following these rules is considered imperative to the success of
5-
the PHP project. Therefore expect your contributions to be of much less positive
4+
mailing lists. Following these rules is considered imperative to the success of
5+
the PHP project. Therefore, expect your contributions to be of much less positive
66
impact if you do not follow these rules. More importantly you can actually
77
assume that not following these rules will hurt the PHP project.
88

99
PHP is developed through the efforts of a large number of people.
10-
Collaboration is a Good Thing(tm), and mailinglists lets us do this. Thus,
11-
following some basic rules with regards to mailinglist usage will:
10+
Collaboration is a Good Thing(tm), and mailing lists lets us do this. Thus,
11+
following some basic rules with regards to mailing list usage will:
1212

1313
a. Make everybody happier, especially those responsible for developing PHP
1414
itself.
@@ -24,11 +24,11 @@ Having said that, here are the organizational rules:
2424
1. Respect other people working on the project.
2525

2626
2. Do not post when you are angry. Any post can wait a few hours. Review
27-
your post after a good breather or a good nights sleep.
27+
your post after a good breather, or a good nights sleep.
2828

29-
3. Make sure you pick the right mailinglist for your posting. Please review
29+
3. Make sure you pick the right mailing list for your posting. Please review
3030
the descriptions on the
31-
[mailinglist overview page](https://www.php.net/mailing-lists.php). When
31+
[mailing list overview page](https://www.php.net/mailing-lists.php). When
3232
in doubt ask a friend or someone you trust on IRC.
3333

3434
4. Make sure you know what you are talking about. PHP is a very large project
@@ -37,8 +37,8 @@ Having said that, here are the organizational rules:
3737
research before posting to the entire developer community.
3838

3939
5. Patches have a much greater chance of acceptance than just asking the
40-
PHP developers to implement a feature for you. For one it makes the
41-
discussion more concrete and it shows that the poster put thought and time
40+
PHP developers to implement a feature for you. For one, it makes the
41+
discussion more concrete, and it shows that the poster put thought and time
4242
into the request.
4343

4444
6. If you are posting to an existing thread, make sure that you know what
@@ -51,7 +51,7 @@ Having said that, here are the organizational rules:
5151
The next few rules are more some general hints:
5252

5353
1. If you notice that your posting ratio is much higher than that of other
54-
people, double check the above rules. Try to wait a bit longer before
54+
people, double-check the above rules. Try to wait a bit longer before
5555
sending your replies to give other people more time to digest your answers
5656
and more importantly give you the opportunity to make sure that you
5757
aggregate your current position into a single mail instead of multiple

‎docs/output-api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ for every output handler op.
108108

109109
## Output handler hooks
110110

111-
The output handler can change its abilities at runtime. Eg. the gz handler can
111+
The output handler can change its abilities at runtime. For example, the gz handler can
112112
remove the CLEANABLE and REMOVABLE bits when the first output has passed through it;
113113
or handlers implemented in C to be used with ob_start() can contain a non-global
114114
context:

‎docs/parameter-parsing-api.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,9 @@ See also
5858
5959
## Type specifiers
6060
61-
The following list shows the type specifier, its meaning and the parameter types
61+
The following list shows the type specifier, its meaning, and the parameter types
6262
that need to be passed by address. All passed parameters are set if the PHP
63-
parameter is non optional and untouched if optional and the parameter is not
63+
parameter is non-optional and untouched if optional and the parameter is not
6464
present. The only exception is O where the zend_class_entry* has to be provided
6565
on input and is used to verify the PHP parameter is an instance of that class.
6666
@@ -95,7 +95,7 @@ The following characters also have a meaning in the specifier string:
9595
by the parsing function if they are not passed to it.
9696
* `/` - use SEPARATE_ZVAL() on the parameter it follows
9797
* `!` - the parameter it follows can be of specified type or NULL. If NULL is
98-
passed and the output for such type is a pointer, then the output pointer is
98+
passed, and the output for such type is a pointer, then the output pointer is
9999
set to a native NULL pointer. For 'b', 'l' and 'd', an extra argument of type
100100
zend_bool* must be passed after the corresponding bool*, zend_long* or
101101
double* arguments, respectively. A non-zero value will be written to the

‎docs/release-process.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ explained at the end of this document in
143143
144144
Note: Remember to update the sha256 checksum information.
145145
146-
2. Skip this step for non stable releases after GA of minor or major versions
146+
2. Skip this step for non-stable releases after GA of minor or major versions
147147
(e.g. announce 7.4.0RC1, but not 7.4.1RC1):
148148
149149
Add a short notice to web-php stating that there is a new release, and
@@ -433,7 +433,7 @@ branch:
433433
1. Email systems@php.net to get setup for access to downloads.php.net and to be added
434434
to the release-managers@ distribution list.
435435
436-
2. Request membership to the Release Managers group on github.
436+
2. Request membership to the Release Managers group on GitHub.
437437
438438
3. Create a GPG key for your @php.net address and publish it by editing
439439
`include/gpg-keys.inc` in the `web-php` repository, adding the output of

‎docs/self-contained-extensions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -169,5 +169,5 @@ points to be regarded.
169169
#define PHP_FOO_VERSION "1.2.3"
170170
```
171171
172-
This macros has to be used within your foo_module_entry to indicate the
172+
This macro has to be used within your foo_module_entry to indicate the
173173
extension version.

‎docs/streams.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ PHPAPI int php_stream_supports_lock(php_stream * stream);
169169
```
170170
171171
This function will return either 1 (success) or 0 (failure) indicating whether
172-
or not a lock can be set on this stream. Typically you can only set locks on
172+
or not a lock can be set on this stream. Typically, you can only set locks on
173173
stdio streams.
174174
175175
## Casting streams
@@ -209,7 +209,7 @@ if you mix ANSI stdio calls on the FILE* with php stream calls on the stream.
209209

210210
If your system has the fopencookie function, php streams can synthesize a
211211
`FILE*` on top of any stream, which is useful for SSL sockets, memory based
212-
streams, data base streams etc. etc.
212+
streams, database streams etc. etc.
213213

214214
In situations where this is not desirable, you should query the stream to see if
215215
it naturally supports `FILE *`. You can use this code snippet for this purpose:
@@ -353,7 +353,7 @@ stream = php_stream_alloc(&my_ops, state, 0, persistent, "r");
353353
```
354354

355355
Once you have that part figured out, you can write your implementation and
356-
define the your own php_stream_ops struct (we called it my_ops in the above
356+
define your own php_stream_ops struct (we called it my_ops in the above
357357
example).
358358

359359
For example, for reading from this weird MySQL stream:

0 commit comments

Comments
 (0)
Please sign in to comment.