Uploaded image for project: 'Request For Comments'
  1. Request For Comments
  2. RFC-522

Add attribute to pexConfig.Field to indicate special attention should be given

    Details

    • Type: RFC
    • Status: Withdrawn
    • Resolution: Done
    • Component/s: DM
    • Labels:
      None

      Description

      Currently our configs per task are very long. Some of the config parameters are changed frequently, but many are essentially never changed (though they remain user setable).

      The proposal is to add a single boolean attribute is_highlight to indicate that the documentation system should treat that field specially to bring it to the fore in the config documentation. This would make it easier for users looking at the documentation to parse out which config parameters they should focus on.

      It would also allow for our docstrings to do something special with them, as well, but that is not part of this RFC.

      Implementation would be simple. Add another argument to the constructor is_highlight=False which simply sets the self.is_highlight attribute in the __init__.

      This would make our documentation much more user friendly at very little cost.

        Attachments

          Issue Links

            Activity

            Hide
            ktl Kian-Tat Lim added a comment -

            Simon Krughoff Jonathan Sick: are we exemplifying, modifying, or withdrawing this?

            Show
            ktl Kian-Tat Lim added a comment - Simon Krughoff Jonathan Sick : are we exemplifying, modifying, or withdrawing this?
            Hide
            krughoff Simon Krughoff added a comment -

            My impression is that the best course of action is to withdraw this as the solution is purely in documentation.

            Show
            krughoff Simon Krughoff added a comment - My impression is that the best course of action is to withdraw this as the solution is purely in documentation.
            Hide
            tjenness Tim Jenness added a comment -

            Simon Krughoff please withdraw the RFC if that is your intention.

            Show
            tjenness Tim Jenness added a comment - Simon Krughoff please withdraw the RFC if that is your intention.
            Hide
            krughoff Simon Krughoff added a comment -

            This will be handled in docs.

            Show
            krughoff Simon Krughoff added a comment - This will be handled in docs.
            Hide
            jsick Jonathan Sick added a comment -

            I've created  DM-17056 to implement this from the reStructuredText side, as discussed above.

            Show
            jsick Jonathan Sick added a comment - I've created  DM-17056  to implement this from the reStructuredText side, as discussed above.

              People

              • Assignee:
                krughoff Simon Krughoff
                Reporter:
                krughoff Simon Krughoff
                Watchers:
                Jim Bosch, John Parejko, John Swinbank, Jonathan Sick, Kian-Tat Lim, Paul Price, Robert Lupton, Simon Krughoff, Tim Jenness
              • Votes:
                0 Vote for this issue
                Watchers:
                9 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:
                  Planned End:

                  Summary Panel