Merge pull request #1271 from myk002/myk_spouse

[gui/pregnancy] set or clear spouse relationships

changelog.txt

@@ -29,7 +29,7 @@ Template for new versions:
 ## New Tools
 - `embark-anyone`: allows you to embark as any civilisation, including dead, and non-dwarven ones
 - `idle-crafting`: Allow dwarfs to automatically satisfy their need to craft objects.
-- `gui/pregnancy`: view and generate pregnancies with specified parents
+- `gui/pregnancy`: view and generate pregnancies or arrange marriages with specified partners
 
 ## New Features
 - `caravan`: DFHack dialogs for trade screens (both ``Bring goods to depot`` and the ``Trade`` barter screen) can now filter by item origins (foreign vs. fort-made) and can filter bins by whether they have a mix of ethically acceptable and unacceptable items in them

docs/gui/pregnancy.rst

@@ -6,7 +6,7 @@ gui/pregnancy
     :tags: adventure fort armok animals units
 
 This tool provides an interface for producing pregnancies with specific mothers
-and fathers.
+and fathers. It can also assign or unassign spouses.
 
 If a unit is selected when you run `gui/pregnancy`, they will be pre-selected
 as a parent. If the unit has a spouse of a different gender, they will be
@@ -21,12 +21,26 @@ A unit must be on the map to participate in a pregnancy. For example, you
 cannot designate a father that is not on-site, even if they are the selected
 mother's spouse.
 
-Children cannot be selected as a parent, and, due to game limitations,
-cross-species pregnancies are not supported.
+You can make the selected parents spouses by clicking on the "Set selected
+<parent> as spouse" button, but the button is only enabled if you first
+dissolve existing spouse relationships for both partners. If either new spouse
+has existing lovers, you'll get a confirmation dialog, and if you choose to
+proceed, the lover relationships will be removed.
+
+Children and units that are insane cannot be selected as a parent, and, due to
+game limitations, cross-species pregnancies are not supported.
 
 Usage
 -----
 
 ::
 
     gui/pregnancy
+
+Technical notes
+---------------
+
+The reason for the requirement that a father must be on the map to contribute
+to a pregnancy is that the genes used for the pregnancy are associated with the
+physical unit. They are not stored with the "historical figure" that represents
+the father when he is off-map.