wiki:2017-02-13

Version 2 (modified by Tom Ferrin, 9 years ago) ( diff )

--

Attendees

  • Conrad, Elaine, Eric, TomG, Greg, TomF

Agenda

  • Continuing discussion from February 6th meeting:
    • Think about overlap between view, position, and camera commands
    • Ribbon (cartoon) lingering issues/suggestions Elaine's summary
    • What is the policy regarding "~"? How do we negate a command? Should we do anything further about "~" or just keep them as aliases?
    • Session saving in alpha release: continue to use pickle or move to msgPack?
    • Need to clean up usage hints
    • "objects" vs. "atom-spec". Usage separates the two concepts (e.g. see select), but help documentation merges them.
    • Should "entity atoms", which means the same molecular entity, be part of the atom-spec?
    • Need more discussion/revision for show only option
    • Need to think about visualization of nucleotides

Discussion

  • Changes to "usage":
    • optional positional arguments will not be listed as keywords
    • argument types with help URL should be shown as links
    • argument types have "displayed" flag that determines whether or not the type and description are listed below syntax
    • if there are 7 or fewer subcommands then each subcommand should be enumerated, otherwise just list the subcommands with a link to each
    • see additional specific changes below
  • "atom-spec" is too specific for some commands, because some objects are not atoms, and "usage" gives different result than "help"

Action Items

  • Add magic numbers to session files - Greg & Conrad
  • TomG to merge "position" command into "view" command
  • Conrad will continue working on ribbons
  • Conrad will add "cartoon hide"
  • Greg will add "hidden" keyword to command registration
  • All command descriptions need to have a synopsis - TomG
  • When commands are registered generate warning if synopsis not present - Greg
  • "usage allOptions <command>" shows hidden options - Greg
  • For commands where atom-spec" is too specific, use another word - Elaine
  • Changes to usage as per above - Greg

Note: See TracWiki for help on using the wiki.