Skip to content

Commit d72f2eb

Browse files
emjay0921emjay0921
committed
fix(cr): align README table widths with CI-generated format
1 parent 8765640 commit d72f2eb

File tree

2 files changed

+91
-102
lines changed

2 files changed

+91
-102
lines changed

‎spp_change_request_v2/README.rst‎

Lines changed: 76 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -47,63 +47,63 @@ Key Capabilities
4747
Key Models
4848
~~~~~~~~~~
4949

50-
+----------------------------------+----------------------------------+
51-
| Model | Description |
52-
+==================================+==================================+
53-
| ``spp.change.request`` | Main change request record with |
54-
| | approval workflow |
55-
+----------------------------------+----------------------------------+
56-
| ``spp.change.request.type`` | Configuration for CR types: |
57-
| | target, detail model, workflow |
58-
+----------------------------------+----------------------------------+
59-
| ``s | Field mappings for automatic |
60-
| pp.change.request.type.mapping`` | application |
61-
+----------------------------------+----------------------------------+
62-
| ``spp.cr.conflict.rule`` | Rules for detecting conflicting |
63-
| | change requests |
64-
+----------------------------------+----------------------------------+
65-
| ``spp.cr.duplicate.config`` | Configuration for duplicate |
66-
| | detection thresholds |
67-
+----------------------------------+----------------------------------+
68-
| ``spp.cr.conflict.mixin`` | Mixin providing conflict and |
69-
| | duplicate detection |
70-
+----------------------------------+----------------------------------+
71-
| ``spp.cr.detail.base`` | Base model for all change |
72-
| | request detail types |
73-
+----------------------------------+----------------------------------+
74-
| ``spp.cr.detail.add_member`` | Detail model for adding members |
75-
| | to groups |
76-
+----------------------------------+----------------------------------+
77-
| ` | Detail model for editing |
78-
| `spp.cr.detail.edit_individual`` | individual registrant data |
79-
+----------------------------------+----------------------------------+
80-
| ``spp.cr.detail.edit_group`` | Detail model for editing |
81-
| | group/household data |
82-
+----------------------------------+----------------------------------+
83-
| ``spp.cr.detail.remove_member`` | Detail model for removing |
84-
| | members from groups |
85-
+----------------------------------+----------------------------------+
86-
| ``spp.cr.detail.change_hoh`` | Detail model for changing head |
87-
| | of household |
88-
+----------------------------------+----------------------------------+
89-
| ` | Detail model for marking |
90-
| `spp.cr.detail.exit_registrant`` | registrants as exited |
91-
+----------------------------------+----------------------------------+
92-
| ` | Detail model for transferring |
93-
| `spp.cr.detail.transfer_member`` | members between groups |
94-
+----------------------------------+----------------------------------+
95-
| ``spp.cr.detail.update_id`` | Detail model for updating |
96-
| | registrant ID numbers |
97-
+----------------------------------+----------------------------------+
98-
| ``spp.cr.detail.create_group`` | Detail model for creating new |
99-
| | groups/households |
100-
+----------------------------------+----------------------------------+
101-
| ``s | Detail model for merging |
102-
| pp.cr.detail.merge_registrants`` | duplicate registrant records |
103-
+----------------------------------+----------------------------------+
104-
| ` | Detail model for splitting |
105-
| `spp.cr.detail.split_household`` | households into separate groups |
106-
+----------------------------------+----------------------------------+
50+
+-------------------------------------+----------------------------------+
51+
| Model | Description |
52+
+=====================================+==================================+
53+
| ``spp.change.request`` | Main change request record with |
54+
| | approval workflow |
55+
+-------------------------------------+----------------------------------+
56+
| ``spp.change.request.type`` | Configuration for CR types: |
57+
| | target, detail model, workflow |
58+
+-------------------------------------+----------------------------------+
59+
| ``spp.change.request.type.mapping`` | Field mappings for automatic |
60+
| | application |
61+
+-------------------------------------+----------------------------------+
62+
| ``spp.cr.conflict.rule`` | Rules for detecting conflicting |
63+
| | change requests |
64+
+-------------------------------------+----------------------------------+
65+
| ``spp.cr.duplicate.config`` | Configuration for duplicate |
66+
| | detection thresholds |
67+
+-------------------------------------+----------------------------------+
68+
| ``spp.cr.conflict.mixin`` | Mixin providing conflict and |
69+
| | duplicate detection |
70+
+-------------------------------------+----------------------------------+
71+
| ``spp.cr.detail.base`` | Base model for all change |
72+
| | request detail types |
73+
+-------------------------------------+----------------------------------+
74+
| ``spp.cr.detail.add_member`` | Detail model for adding members |
75+
| | to groups |
76+
+-------------------------------------+----------------------------------+
77+
| ``spp.cr.detail.edit_individual`` | Detail model for editing |
78+
| | individual registrant data |
79+
+-------------------------------------+----------------------------------+
80+
| ``spp.cr.detail.edit_group`` | Detail model for editing |
81+
| | group/household data |
82+
+-------------------------------------+----------------------------------+
83+
| ``spp.cr.detail.remove_member`` | Detail model for removing |
84+
| | members from groups |
85+
+-------------------------------------+----------------------------------+
86+
| ``spp.cr.detail.change_hoh`` | Detail model for changing head |
87+
| | of household |
88+
+-------------------------------------+----------------------------------+
89+
| ``spp.cr.detail.exit_registrant`` | Detail model for marking |
90+
| | registrants as exited |
91+
+-------------------------------------+----------------------------------+
92+
| ``spp.cr.detail.transfer_member`` | Detail model for transferring |
93+
| | members between groups |
94+
+-------------------------------------+----------------------------------+
95+
| ``spp.cr.detail.update_id`` | Detail model for updating |
96+
| | registrant ID numbers |
97+
+-------------------------------------+----------------------------------+
98+
| ``spp.cr.detail.create_group`` | Detail model for creating new |
99+
| | groups/households |
100+
+-------------------------------------+----------------------------------+
101+
| ``spp.cr.detail.merge_registrants`` | Detail model for merging |
102+
| | duplicate registrant records |
103+
+-------------------------------------+----------------------------------+
104+
| ``spp.cr.detail.split_household`` | Detail model for splitting |
105+
| | households into separate groups |
106+
+-------------------------------------+----------------------------------+
107107

108108
Form Tabs
109109
~~~~~~~~~
@@ -158,25 +158,25 @@ UI Location
158158
Security
159159
~~~~~~~~
160160

161-
+----------------------------------+----------------------------------+
162-
| Group | Access |
163-
+==================================+==================================+
164-
| ``spp_c | Create and submit change |
165-
| hange_request_v2.group_cr_user`` | requests (read/write/create) |
166-
+----------------------------------+----------------------------------+
167-
| ``spp_change | Approve/reject, field-level |
168-
| _request_v2.group_cr_validator`` | validation (read/write/create) |
169-
+----------------------------------+----------------------------------+
170-
| ``spp_change_re | HQ-level approval with registry |
171-
| quest_v2.group_cr_validator_hq`` | write (read/write/create) |
172-
+----------------------------------+----------------------------------+
173-
| ``spp_chan | Full CRUD including |
174-
| ge_request_v2.group_cr_manager`` | configuration |
175-
+----------------------------------+----------------------------------+
176-
| ``spp_change_request | Override blocking conflict |
177-
| _v2.group_cr_conflict_approver`` | detections |
178-
| | (specialized/functional) |
179-
+----------------------------------+----------------------------------+
161+
+------------------------------------------------------+----------------------------------+
162+
| Group | Access |
163+
+======================================================+==================================+
164+
| ``spp_change_request_v2.group_cr_user`` | Create and submit change |
165+
| | requests (read/write/create) |
166+
+------------------------------------------------------+----------------------------------+
167+
| ``spp_change_request_v2.group_cr_validator`` | Approve/reject, field-level |
168+
| | validation (read/write/create) |
169+
+------------------------------------------------------+----------------------------------+
170+
| ``spp_change_request_v2.group_cr_validator_hq`` | HQ-level approval with registry |
171+
| | write (read/write/create) |
172+
+------------------------------------------------------+----------------------------------+
173+
| ``spp_change_request_v2.group_cr_manager`` | Full CRUD including |
174+
| | configuration |
175+
+------------------------------------------------------+----------------------------------+
176+
| ``spp_change_request_v2.group_cr_conflict_approver`` | Override blocking conflict |
177+
| | detections |
178+
| | (specialized/functional) |
179+
+------------------------------------------------------+----------------------------------+
180180

181181
Extension Points
182182
~~~~~~~~~~~~~~~~

‎spp_change_request_v2/static/description/index.html‎

Lines changed: 15 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -396,8 +396,8 @@ <h1>Key Capabilities</h1>
396396
<h1>Key Models</h1>
397397
<table border="1" class="docutils">
398398
<colgroup>
399-
<col width="50%" />
400-
<col width="50%" />
399+
<col width="52%" />
400+
<col width="48%" />
401401
</colgroup>
402402
<thead valign="bottom">
403403
<tr><th class="head">Model</th>
@@ -413,8 +413,7 @@ <h1>Key Models</h1>
413413
<td>Configuration for CR types:
414414
target, detail model, workflow</td>
415415
</tr>
416-
<tr><td><tt class="docutils literal">s
417-
pp.change.request.type.mapping</tt></td>
416+
<tr><td><tt class="docutils literal">spp.change.request.type.mapping</tt></td>
418417
<td>Field mappings for automatic
419418
application</td>
420419
</tr>
@@ -438,8 +437,7 @@ <h1>Key Models</h1>
438437
<td>Detail model for adding members
439438
to groups</td>
440439
</tr>
441-
<tr><td>`
442-
<cite>spp.cr.detail.edit_individual`</cite></td>
440+
<tr><td><tt class="docutils literal">spp.cr.detail.edit_individual</tt></td>
443441
<td>Detail model for editing
444442
individual registrant data</td>
445443
</tr>
@@ -455,13 +453,11 @@ <h1>Key Models</h1>
455453
<td>Detail model for changing head
456454
of household</td>
457455
</tr>
458-
<tr><td>`
459-
<cite>spp.cr.detail.exit_registrant`</cite></td>
456+
<tr><td><tt class="docutils literal">spp.cr.detail.exit_registrant</tt></td>
460457
<td>Detail model for marking
461458
registrants as exited</td>
462459
</tr>
463-
<tr><td>`
464-
<cite>spp.cr.detail.transfer_member`</cite></td>
460+
<tr><td><tt class="docutils literal">spp.cr.detail.transfer_member</tt></td>
465461
<td>Detail model for transferring
466462
members between groups</td>
467463
</tr>
@@ -473,13 +469,11 @@ <h1>Key Models</h1>
473469
<td>Detail model for creating new
474470
groups/households</td>
475471
</tr>
476-
<tr><td><tt class="docutils literal">s
477-
pp.cr.detail.merge_registrants</tt></td>
472+
<tr><td><tt class="docutils literal">spp.cr.detail.merge_registrants</tt></td>
478473
<td>Detail model for merging
479474
duplicate registrant records</td>
480475
</tr>
481-
<tr><td>`
482-
<cite>spp.cr.detail.split_household`</cite></td>
476+
<tr><td><tt class="docutils literal">spp.cr.detail.split_household</tt></td>
483477
<td>Detail model for splitting
484478
households into separate groups</td>
485479
</tr>
@@ -541,37 +535,32 @@ <h1>UI Location</h1>
541535
<h1>Security</h1>
542536
<table border="1" class="docutils">
543537
<colgroup>
544-
<col width="50%" />
545-
<col width="50%" />
538+
<col width="61%" />
539+
<col width="39%" />
546540
</colgroup>
547541
<thead valign="bottom">
548542
<tr><th class="head">Group</th>
549543
<th class="head">Access</th>
550544
</tr>
551545
</thead>
552546
<tbody valign="top">
553-
<tr><td><tt class="docutils literal">spp_c
554-
hange_request_v2.group_cr_user</tt></td>
547+
<tr><td><tt class="docutils literal">spp_change_request_v2.group_cr_user</tt></td>
555548
<td>Create and submit change
556549
requests (read/write/create)</td>
557550
</tr>
558-
<tr><td><tt class="docutils literal">spp_change
559-
_request_v2.group_cr_validator</tt></td>
551+
<tr><td><tt class="docutils literal">spp_change_request_v2.group_cr_validator</tt></td>
560552
<td>Approve/reject, field-level
561553
validation (read/write/create)</td>
562554
</tr>
563-
<tr><td><tt class="docutils literal">spp_change_re
564-
quest_v2.group_cr_validator_hq</tt></td>
555+
<tr><td><tt class="docutils literal">spp_change_request_v2.group_cr_validator_hq</tt></td>
565556
<td>HQ-level approval with registry
566557
write (read/write/create)</td>
567558
</tr>
568-
<tr><td><tt class="docutils literal">spp_chan
569-
ge_request_v2.group_cr_manager</tt></td>
559+
<tr><td><tt class="docutils literal">spp_change_request_v2.group_cr_manager</tt></td>
570560
<td>Full CRUD including
571561
configuration</td>
572562
</tr>
573-
<tr><td><tt class="docutils literal">spp_change_request
574-
_v2.group_cr_conflict_approver</tt></td>
563+
<tr><td><tt class="docutils literal">spp_change_request_v2.group_cr_conflict_approver</tt></td>
575564
<td>Override blocking conflict
576565
detections
577566
(specialized/functional)</td>

0 commit comments

Comments
 (0)