Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(serializers): fix hyperlinks to salt.serializers #56325

Merged
merged 13 commits into from
Apr 16, 2020
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Versions are `MAJOR.PATCH`.
### Changed

### Fixed
- [#56325](https://github.com/saltstack/salt/pull/56325) - Fix hyperlinks to `salt.serializers` and other documentation issues - [@myii](https://github.com/myii)

### Added

Expand Down
4 changes: 2 additions & 2 deletions doc/topics/development/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ Fork a Repo Guide_>`_ and is well worth reading.

GOOD

.. code-block::
.. code-block:: bash

Fix broken things in file1 and file2

Expand All @@ -157,7 +157,7 @@ Fork a Repo Guide_>`_ and is well worth reading.

BAD

.. code-block::
.. code-block:: bash

Fixes broken things

Expand Down
2 changes: 1 addition & 1 deletion doc/topics/development/conventions/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ Documentation Changes and Fixes
Documentation changes and fixes should be made against the earliest supported
release branch that the update applies to. The practice of updating a release
branch instead of making all documentation changes against Salt's main, default
branch, ``develop``, is necessary in order for the docs to be as up-to-date as
branch, ``master``, is necessary in order for the docs to be as up-to-date as
possible when the docs are built.

The workflow mentioned above is also in line with the recommendations outlined
Expand Down
2 changes: 1 addition & 1 deletion doc/topics/releases/3000.rst
Original file line number Diff line number Diff line change
Expand Up @@ -555,7 +555,7 @@ the ``engine_module`` parameter in the engine configuration.
host: localhost
port: 24224

.. code-block::
.. code-block:: none

<source>
@type forward
Expand Down
8 changes: 4 additions & 4 deletions salt/modules/slsutil.py
Original file line number Diff line number Diff line change
Expand Up @@ -203,8 +203,8 @@ def _get_serialize_fn(serializer, fn_name):

def serialize(serializer, obj, **mod_kwargs):
'''
Serialize a Python object using a :py:mod:`serializer module
<salt.serializers>`
Serialize a Python object using one of the available
:ref:`all-salt.serializers`.

CLI Example:

Expand All @@ -225,8 +225,8 @@ def serialize(serializer, obj, **mod_kwargs):

def deserialize(serializer, stream_or_string, **mod_kwargs):
'''
Deserialize a Python object using a :py:mod:`serializer module
<salt.serializers>`
Deserialize a Python object using one of the available
:ref:`all-salt.serializers`.

CLI Example:

Expand Down
4 changes: 2 additions & 2 deletions salt/states/file.py
Original file line number Diff line number Diff line change
Expand Up @@ -6873,8 +6873,8 @@ def serialize(name,
.. versionadded:: 2015.8.0

formatter
Write the data as this format. See the list of :py:mod:`serializer
modules <salt.serializers>` for supported output formats.
Write the data as this format. See the list of
:ref:`all-salt.serializers` for supported output formats.

encoding
If specified, then the specified encoding will be used. Otherwise, the
Expand Down