Shorten wrapped "ls" descriptions in scripts

2015-11-10 13:21:00 +11:00 · 2015-11-10 13:21:00 +11:00 · fc9e2fbff7
parent feff83cedc
commit fc9e2fbff7
39 changed files with 52 additions and 49 deletions
--- a/scripts/adaptation.rb
+++ b/scripts/adaptation.rb
@ -1,4 +1,4 @@
-# View or set level of cavern adaptation for the selected unit or the whole fort
+# View or set cavern adaptation levels
 # based on removebadthoughts.rb
 =begin

--- a/scripts/armoks-blessing.lua
+++ b/scripts/armoks-blessing.lua
@ -1,7 +1,4 @@
-- Adjust all attributes, personality, age and skills of all dwarves in play
-- without arguments, all attributes, age & personalities are adjusted
-- arguments allow for skills to be adjusted as well
-- WARNING: USING THIS SCRIPT WILL ADJUST ALL DWARVES IN PLAY!
+-- Adjust all attributes of all dwarves to an ideal
 -- by vjek
 --[[=begin

@ -12,6 +9,9 @@ Runs the equivalent of `rejuvenate`, `elevate-physical`, `elevate-mental`, and
 which sets every stat to an ideal - legendary skills, great traits, and
 easy-to-satisfy preferences.

+Without arguments, all attributes, age & personalities are adjusted.
+Arguments allow for skills to be adjusted as well.
+
 =end]]
 function rejuvenate(unit)
    if unit==nil then
--- a/scripts/autofarm.rb
+++ b/scripts/autofarm.rb
@ -1,4 +1,4 @@
-
+# Select cropt to plant based on current stocks
 =begin

 autofarm
--- a/scripts/autolabor-artisans.lua
+++ b/scripts/autolabor-artisans.lua
@ -1,10 +1,14 @@
-- Executes an autolabor command for each labor where skill level influences output quality.
+-- Run an autolabor command for skill-affected labors.

 --[[=begin

 autolabor-artisans
 ==================
-Runs `autolabor`, with settings tuned for small but highly skilled workforces.
+Runs an `autolabor` command, for all labors where skill level
+influences output quality.  Examples::
+
+    autolabor-artisans 0 2 3
+    autolabor-artisans disable

 =end]]
 local artisan_labors = {
--- a/scripts/brainwash.lua
+++ b/scripts/brainwash.lua
@ -1,4 +1,4 @@
-- This script will brainwash a dwarf, modifying their personality
+-- Brainwash a dwarf, modifying their personality
 -- usage is:  target a unit in DF, and execute this script in dfhack
 -- by vjek
 --[[=begin
--- a/scripts/deterioratefood.rb
+++ b/scripts/deterioratefood.rb
@ -1,4 +1,4 @@
-# Make food and plants decay, and vanish after a few months
+# Food and plants decay, and vanish after a few months
 =begin

 deterioratefood
--- a/scripts/devel/inject-raws.lua
+++ b/scripts/devel/inject-raws.lua
@ -1,4 +1,4 @@
-- Injects new reaction, item and building defs into the world.
+-- Inject new raw definitions into the world
 --[[=begin

 devel/inject-raws
@ -9,6 +9,8 @@ This script attempts to inject new raw objects into your
 world. If the injected references do not match the actual
 edited raws, your save will refuse to load, or load but crash.

+This script can handle reaction, item and building definitions.
+
 The savegame contains a list of the relevant definition tokens in
 the right order, but all details are read from raws every time.
 This allows just adding stub definitions, and simply saving and
--- a/scripts/devel/inspect-screen.lua
+++ b/scripts/devel/inspect-screen.lua
@ -1,4 +1,4 @@
-- Read the tiles from the screen and display info about them.
+-- Read from the screen and display info about the tiles
 --[[=begin

 devel/inspect-screen
--- a/scripts/devel/list-filters.lua
+++ b/scripts/devel/list-filters.lua
@ -1,4 +1,4 @@
-- List input items for the building currently being built.
+-- List input items for the building being built.
 --[[=begin

 devel/list-filters
--- a/scripts/devel/nuke-items.lua
+++ b/scripts/devel/nuke-items.lua
@ -1,4 +1,4 @@
-- Deletes ALL items not held by units, buildings or jobs.
+-- Delete ALL items not held by units, buildings or jobs
 --[[=begin

 devel/nuke-items
--- a/scripts/devel/prepare-save.lua
+++ b/scripts/devel/prepare-save.lua
@ -1,4 +1,4 @@
-- Prepare the current save for use with devel/find-offsets.
+-- Prepare the current save for devel/find-offsets
 --[[=begin

 devel/prepare-save
--- a/scripts/devel/scanitemother.rb
+++ b/scripts/devel/scanitemother.rb
@ -1,4 +1,4 @@
-# list indices in world.item.other[] where current selected item appears
+# list selected item's indices in world.item.other[]
 =begin

 devel/scanitemother
--- a/scripts/devel/spawn-unit-helper.rb
+++ b/scripts/devel/spawn-unit-helper.rb
@ -1,4 +1,4 @@
-# setup stuff to allow arena creature spawn after a mode change
+# Allow arena creature spawn after a mode change

 df.world.arena_spawn.race.clear
 df.world.arena_spawn.caste.clear
--- a/scripts/devel/test-perlin.lua
+++ b/scripts/devel/test-perlin.lua
@ -1,4 +1,4 @@
-- Generates an image using multiple octaves of perlin noise.
+-- Generates an image using perlin noise
 --[[=begin

 devel/test-perlin
--- a/scripts/digfort.rb
+++ b/scripts/digfort.rb
@ -1,4 +1,4 @@
-# designate an area for digging according to a plan in csv format
+# designate an area based on a '.csv' plan
 =begin

 digfort
--- a/scripts/elevate-mental.lua
+++ b/scripts/elevate-mental.lua
@ -1,4 +1,4 @@
-- This script will elevate all the mental attributes of a unit
+-- Elevate all the mental attributes of a unit
 -- by vjek
 --[[=begin

--- a/scripts/elevate-physical.lua
+++ b/scripts/elevate-physical.lua
@ -1,4 +1,4 @@
-- This script will elevate all the physical attributes of a unit
+-- Elevate all the physical attributes of a unit
 -- by vjek
 --[[=begin

--- a/scripts/fix/blood-del.lua
+++ b/scripts/fix/blood-del.lua
@ -1,6 +1,5 @@
--makes it so that civs won't come with barrels full of blood, ichor, or goo
--author Urist Da Vinci
--edited by expwnent, scamtank
+-- Stop traders bringing blood, ichor, or goo
+--author Urist Da Vinci; edited by expwnent, scamtank
 --[[=begin

 fix/blood-del
--- a/scripts/fix/loyaltycascade.rb
+++ b/scripts/fix/loyaltycascade.rb
@ -1,4 +1,4 @@
-# script to fix loyalty cascade, when you order your militia to kill friendly units
+# Cancels a 'loyalty cascade' when citizens are killed
 =begin

 fix/loyaltycascade
--- a/scripts/fix/population-cap.lua
+++ b/scripts/fix/population-cap.lua
@ -1,4 +1,4 @@
-- Communicates current population to mountainhomes to avoid cap overshooting.
+-- Tells mountainhomes your pop. to avoid overshoot

 --[[=begin

--- a/scripts/gaydar.lua
+++ b/scripts/gaydar.lua
@ -1,4 +1,4 @@
-local utils = require('utils')
+-- Shows the sexual orientation of units
 --[[=begin

 gaydar
@ -8,6 +8,7 @@ the viability of livestock breeding programs.  Use ``gaydar -help`` for informat
 on available filters for orientation, citizenship, species, etc.

 =end]]
+local utils = require('utils')

 validArgs = utils.invert({
  'all',
--- a/scripts/growcrops.rb
+++ b/scripts/growcrops.rb
@ -1,4 +1,4 @@
-# grow crops in farm plots. ex: growcrops helmet_plump 20
+# Instantly grow crops in farm plots
 =begin

 growcrops
--- a/scripts/gui/advfort_items.lua
+++ b/scripts/gui/advfort_items.lua
@ -1,4 +1,4 @@
-
+--Does something with items in adventure mode jobs
 --[[=begin

 gui/advfort_items
--- a/scripts/gui/assign-rack.lua
+++ b/scripts/gui/assign-rack.lua
@ -1,5 +1,4 @@
-- Assign weapon racks to squads. Requires the weaponrack-unassign patch.
-
+-- Assign weapon racks to squads (needs binpatch)
 --[[=begin

 gui/assign-rack
--- a/scripts/gui/choose-weapons.lua
+++ b/scripts/gui/choose-weapons.lua
@ -1,4 +1,4 @@
-- Rewrite individual choice weapons into specific types.
+-- Rewrite individual choice weapons to specific types
 --[[=begin

 gui/choose-weapons
--- a/scripts/gui/clone-uniform.lua
+++ b/scripts/gui/clone-uniform.lua
@ -1,4 +1,4 @@
-- Clone the current uniform template in the military screen.
+-- Clone a uniform template in the military screen
 --[[=begin

 gui/clone-uniform
--- a/scripts/gui/companion-order.lua
+++ b/scripts/gui/companion-order.lua
@ -1,4 +1,4 @@
-
+-- Issue orders to companions in Adventure mode
 --[[=begin

 gui/companion-order
--- a/scripts/gui/gm-unit.lua
+++ b/scripts/gui/gm-unit.lua
@ -1,4 +1,4 @@
-- Interface powered (somewhat user friendly) unit editor.
+-- Interface powered, user friendly, unit editor

 --[[=begin

--- a/scripts/gui/guide-path.lua
+++ b/scripts/gui/guide-path.lua
@ -1,4 +1,4 @@
-- Show and manipulate the path used by Guide Cart orders.
+-- Show/change the path used by Guide Cart orders
 --[[=begin

 gui/guide-path
--- a/scripts/hfs-pit.lua
+++ b/scripts/hfs-pit.lua
@ -1,4 +1,4 @@
-- Creates a pit under the target leading straight to the Underworld.  Type '?' for help.
+-- Creates a pit to the Underworld under the target
 -- Based on script by IndigoFenix, @ https://gist.github.com/IndigoFenix/8776696
 --[[=begin

--- a/scripts/make-legendary.lua
+++ b/scripts/make-legendary.lua
@ -1,5 +1,4 @@
-- This script will modify a skill or the skills of a single unit
-- the skill will be increased to 20 (Legendary +5)
+-- Make a skill or skills of a unit Legendary +5
 -- by vjek
 --[[=begin

--- a/scripts/markdown.lua
+++ b/scripts/markdown.lua
@ -1,4 +1,4 @@
-- Save a copy of a text screen in markdown (for reddit among others). Use 'markdown help' for more details.
+-- Save a text screen in markdown (eg for reddit)
 -- This is a derivatiwe work based upon scripts/forum-dwarves.lua by Caldfir and expwnent
 -- Adapted for markdown by Mchl https://github.com/Mchl
 --[[=begin
--- a/scripts/migrants-now.lua
+++ b/scripts/migrants-now.lua
@ -1,4 +1,4 @@
-- Force a migrant wave (only works after hardcoded waves)
+-- Force a migrant wave (only after hardcoded waves)
 --[[=begin

 migrants-now
--- a/scripts/region-pops.lua
+++ b/scripts/region-pops.lua
@ -1,4 +1,4 @@
-- Shows populations of animals in the region, and allows tweaking them.
+-- Show or edit regional plant and animal populations
 --[[=begin

 region-pops
--- a/scripts/show-unit-syndromes.rb
+++ b/scripts/show-unit-syndromes.rb
@ -1,6 +1,5 @@
-# Show syndromes affecting units and the remaining and maximum duration
-# original author: drayath
-# edited by expwnent
+# Show syndromes affecting units, including duration
+# original author: drayath, edited by expwnent
 =begin

 show-unit-syndromes
--- a/scripts/siren.lua
+++ b/scripts/siren.lua
@ -1,4 +1,4 @@
-- Wakes up the sleeping, breaks up parties and stops breaks.
+-- Wakes up the sleeping, ends breaks and parties
 --[[=begin

 siren
--- a/scripts/source.rb
+++ b/scripts/source.rb
@ -1,4 +1,4 @@
-# create an infinite magma/water source/drain at the cursor
+# create an infinite source/drain of magma/water
 =begin

 source
--- a/scripts/starvingdead.rb
+++ b/scripts/starvingdead.rb
@ -1,4 +1,4 @@
-# Make undead units weaken after one month, and vanish after six
+# Weaken and eventually destroy undead over time
 =begin

 starvingdead
--- a/scripts/warn-starving.lua
+++ b/scripts/warn-starving.lua
@ -1,4 +1,4 @@
-- Pauses the game with a warning if a creature is starving, dehydrated, or very drowsy.
+-- Pause and warn if a unit is starving
 -- By Meneth32, PeridexisErrant, Lethosor
 --@ module = true
 --[[=begin