Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
mpenning committed Nov 29, 2023
1 parent a499c6e commit ef15f97
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 3 additions & 5 deletions sphinx-doc/legacy_syntax.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,14 @@
=====================================================

.. warning::
The methods covered in this section are only for documentation purposes. As of version 1.9.43, they are offically removed from CiscoConfParse.
The methods covered in this section are only for documentation purposes. As of version 1.9.43, they are offically removed from CiscoConfParse. Refer to the :ref:`tutorial` for the latest API information.


This section will cover the legacy :class:`~ciscoconfparse.CiscoConfParse()`
syntax; these were the original methods before version 1.0.0; legacy
methods always returned text strings. This makes them easier to learn, but
harder to write complex scripts with. There is nothing wrong with continuing to use these methods; however, you will probably find that your scripts are more
efficient if you use the newer methods that manipulate
:class:`~models_cisco.IOSCfgLine()` objects, which were introduced in
version 1.0.0.
harder to write complex scripts with. There is nothing wrong with continuing to use these methods; however, they have been removed as of CiscoConfParse version 1.9.43.


Baseline configuration
----------------------
Expand Down
2 changes: 2 additions & 0 deletions sphinx-doc/tutorial.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _tutorial:

================================================
:class:`~ciscoconfparse.CiscoConfParse` Tutorial
================================================
Expand Down

0 comments on commit ef15f97

Please sign in to comment.