From 789fc6dde06b7667b434b51015498dc8b8ac886d Mon Sep 17 00:00:00 2001 From: lethosor Date: Fri, 23 Jun 2017 12:44:34 -0400 Subject: [PATCH] Documentation tweaks - Improve link in Binpatches.rst - Fix `alias` anchor in Core.rst (ref #701) - Increase depth of Plugins.rst table of contents. Some plugins were hard to find because they fit in multiple categories. --- docs/Binpatches.rst | 7 +++---- docs/Core.rst | 6 +++++- docs/Plugins.rst | 2 +- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/docs/Binpatches.rst b/docs/Binpatches.rst index 53e1455b4..a0fcc6630 100644 --- a/docs/Binpatches.rst +++ b/docs/Binpatches.rst @@ -13,15 +13,14 @@ the `binpatch` command. We recommend using a script or plugin instead of a raw patch if at all possible - that way your work will work for many versions - across multiple operating systems. There's a reason nobody has - written patches since ``0.34.11``! + across multiple operating systems. .. contents:: Getting a patch =============== -There are no binary patches available for Dwarf Fortress versions after 0.34.11 +There are no binary patches available for Dwarf Fortress versions after 0.34.11. This system is kept for the chance that someone will find it useful, so some hints on how to write your own follow. This will require disassembly and @@ -29,7 +28,7 @@ decent skill in `memory research `. * The patches are expected to be encoded in text format used by IDA. -* See :commit:`8a9e3d1a728` for examples. +* See `the patches folder in commit b0e1b51 `_ for examples. * :issue:`546` is about the future of the binpatches, and may be useful reading. diff --git a/docs/Core.rst b/docs/Core.rst index 2c5d1168f..15adcc533 100644 --- a/docs/Core.rst +++ b/docs/Core.rst @@ -104,7 +104,8 @@ of DFhack, rather than plugins or scripts. .. contents:: :local: -.. _cls: + +.. _alias: alias ----- @@ -129,6 +130,9 @@ be passed to the underlying command in order. An example with `devel/print-args` example text + +.. _cls: + cls --- Clear the terminal. Does not delete command history. diff --git a/docs/Plugins.rst b/docs/Plugins.rst index 75e3a8f8e..95d827f71 100644 --- a/docs/Plugins.rst +++ b/docs/Plugins.rst @@ -10,7 +10,7 @@ Most commands offered by plugins are listed here, hopefully organised in a way you will find useful. .. contents:: - :depth: 2 + :depth: 3 =============================== Data inspection and visualizers