Skip to content

Commit aaf3bff

Browse files
authored
Merge pull request #7300 from kenjis/fix-docs-request.rst
docs: small improvements in request.rst
2 parents c6de39f + 983b0da commit aaf3bff

1 file changed

Lines changed: 9 additions & 8 deletions

File tree

user_guide_src/source/incoming/request.rst

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ This class
1010
provides the common functionality they both need, but both cases have custom classes that extend
1111
from the Request class to add specific functionality. In practice, you will need to use these classes.
1212

13-
See the documentation for the :doc:`IncomingRequest Class </incoming/incomingrequest>` and
14-
:doc:`CURLRequest Class </libraries/curlrequest>` for more usage details.
13+
See the documentation for the :doc:`IncomingRequest Class <./incomingrequest>` and
14+
:doc:`CURLRequest Class <../libraries/curlrequest>` for more usage details.
1515

16+
***************
1617
Class Reference
1718
***************
1819

@@ -23,11 +24,11 @@ Class Reference
2324
.. php:method:: getIPAddress()
2425
2526
:returns: The user's IP Address, if it can be detected. If the IP address
26-
is not a valid IP address, then will return 0.0.0.0.
27+
is not a valid IP address, then will return ``0.0.0.0``.
2728
:rtype: string
2829

2930
Returns the IP address for the current user. If the IP address is not valid, the method
30-
will return '0.0.0.0':
31+
will return ``0.0.0.0``:
3132

3233
.. literalinclude:: request/001.php
3334

@@ -42,7 +43,7 @@ Class Reference
4243
.. important:: This method is deprecated. It will be removed in future releases.
4344

4445
:param string $ip: IP address
45-
:param string $which: IP protocol ('ipv4' or 'ipv6')
46+
:param string $which: IP protocol (``ipv4`` or ``ipv6``)
4647
:returns: true if the address is valid, false if not
4748
:rtype: bool
4849

@@ -53,7 +54,7 @@ Class Reference
5354

5455
.. literalinclude:: request/002.php
5556

56-
Accepts an optional second string parameter of 'ipv4' or 'ipv6' to specify
57+
Accepts an optional second string parameter of ``ipv4`` or ``ipv6`` to specify
5758
an IP format. The default checks for both formats.
5859

5960
.. php:method:: getMethod([$upper = false])
@@ -95,7 +96,7 @@ Class Reference
9596
:rtype: mixed
9697

9798
This method is identical to the ``getPost()``, ``getGet()`` and ``getCookie()`` methods from the
98-
:doc:`IncomingRequest Class </incoming/incomingrequest>`, only it fetches server data (``$_SERVER``):
99+
:doc:`IncomingRequest Class <./incomingrequest>`, only it fetches server data (``$_SERVER``):
99100

100101
.. literalinclude:: request/004.php
101102

@@ -113,7 +114,7 @@ Class Reference
113114
:rtype: mixed
114115

115116
This method is identical to the ``getPost()``, ``getGet()`` and ``getCookie()`` methods from the
116-
:doc:`IncomingRequest Class </incoming/incomingrequest>`, only it fetches env data (``$_ENV``):
117+
:doc:`IncomingRequest Class <./incomingrequest>`, only it fetches env data (``$_ENV``):
117118

118119
.. literalinclude:: request/006.php
119120

0 commit comments

Comments
 (0)