Date

Attendees

Goals

  • Look over Simon's code review of the SFP docs

Actionable items

ItemNotesStatus
How do we make sure code and docs are tightly coupled, for parts that are filled in by hand vs. docstrings filled by developers?
  • Not clear this has a solved answer currently, but we will adopt the tentative idea that documentarians will be mailed whenever major code portions are completed - e.g. the close of stories or epics, and will then check to see if the docs are up to date with the current code
  • We will also want examples to be in the CI flow, and whenever they break from code updates, this will immediately trigger editing of them, and potentially the example documentation as well
Longer term
Inserting links to Framework docs
  • Perhaps there can be a higher level page links to the Framework docs
  • In Python Usage section: maybe there can be links for this instead
  • Another thing is we could add Task badge / sfp page badges so folks know where they are in the docs structure. Kind of like labels for these pages.  

-→ 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 procCcdWant to put this in, in parallel to the other sfp tasks – even if it turns out it will be very minimalDone
Making charImg API page look betterWill attempt to insert the links properly for this again (as Jonathan pointed to with the stub page syntax)
Formatting for params in config tables
  • Put in double quotes and dbticks (double backticks) for strings

  • Just dbticks for #’s


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 styleRemove 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 pageIn current tech, we can't do this, so for now, comment in rst that we will want thisDone
Get embedded lists workingUsed 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

  •