ALMAS 1.4b1 RTF Avatar
  1. OMG Issue

ALMAS14 — Operation tables for interfaces aren't easy to read

  • Key: ALMAS14-7
  • Status: closed  
  • Source: BAE SYSTEMS ( Mr. Simon Mettrick)
  • Summary:

    The formatting of tables for operations for interface classes doesn't aid readability

  • Reported: ALMAS 1.1 — Sat, 5 Feb 2022 16:04 GMT
  • Disposition: Resolved — ALMAS 1.4b1
  • Disposition Summary:

    Insert Extra Whitespace

    The tables are difficult to read particularly because long parameter lists are on the same logical line. The document has consequently adjusted the width of columns 1 & 2 to be large, leading to a very narrow column for the summaries in some tables.

    For Operation Tables in sections 6.1 & 6.3
    Newline characters should be inserted:

    • between the operation name and the opening parenthesis in column 1
    • before the opening square bracket around parameters in column 2
    • after the closing square bracket around parameters in column 2
    • after each comma separating parameters in column 2
      Additional spaces are after commas between parameters should be removed from column 2
      Column widths should be adjusted to maximise the width of column 3 (summary) subject to not breaking individual words/identifiers across a line in columns 1 & 2
  • Updated: Mon, 24 Mar 2025 13:40 GMT
  • Attachments: