Date
Attendees
Goals
- Look over Simon's code review of the SFP docs
Actionable items
Item | Notes | Status |
---|---|---|
How do we make sure code and docs are tightly coupled, for parts that are filled in by hand vs. docstrings filled by developers? |
| Longer term |
Inserting links to Framework docs |
-→ Tdl- Let’s put placeholder comments in the rst files for where links would be | Done |
Altering destination for where CLT link goes | When writing text, then we just need to thinking where reader wants to go. Should be resistance to linking to a page written a dif style than your section (This was for changing where `command line task`_ goes to, in procCcd) | Done |
API page for procCcd | Want to put this in, in parallel to the other sfp tasks – even if it turns out it will be very minimal | Done |
Making charImg API page look better | Will attempt to insert the links properly for this again (as Jonathan pointed to with the stub page syntax) | |
Formatting for params in config tables |
sbticks (single backticks): will be interpreted as the 'default role' in rst, which links to python objs dbticks: interpreted as code literal – i.e. monospace | Done |
Make sure location for link to src code is consistent with style | Remove current link to github src for procCcd.py (we'll insert later when we have the API pages properly set up for all tasks) | Done |
Want 'options' in run signature to link to CLT page | In current tech, we can't do this, so for now, comment in rst that we will want this | Done |
Get embedded lists working | Used JSick suggestion to make entire table in raw html, vs. only the embedded list (appended in the case of isrTask, made fully for procCcd, other 2 didn't need any adjustment) | Done |
See Also:
Response to Simon's review points, in table form: Response to Simon K's comments on (sfp) Docs Status