FOCUS_Spec icon indicating copy to clipboard operation
FOCUS_Spec copied to clipboard

[EDITORIAL] Column doc link formatting fix

Open AWS-ZachErdman opened this issue 1 year ago • 4 comments

We inconsistently wrote the names of columns in the links that link to columns throughout the spec. Sometimes they would have a space between words and sometimes not. I adjusted all column links to have no spacing between words to make it clear it was a column.

I also fixed a link to ContractedUnitPrice that incorrectly linked to the glossary.

AWS-ZachErdman avatar May 21 '24 21:05 AWS-ZachErdman

Should Numeric Format be updated?

I don't think that's needed since it's not a column in FOCUS, so it wouldn't appear as NumericFormat.

AWS-ZachErdman avatar May 23 '24 17:05 AWS-ZachErdman

@AWS-ZachErdman The group discussed this topic and indicated that it was intentionally defined with a blank space when the column is not listed as a Mandatory requirement.

jpradocueva avatar May 23 '24 18:05 jpradocueva

I see - when the column is being referenced in a requirement, it's supposed to not have a space.

AWS-ZachErdman avatar May 23 '24 18:05 AWS-ZachErdman

Extracted from the Members' Group, Meeting Minutes, May 23.

Some members noted that certain names were intentionally defined with a space, such as "Billing Currency" instead of "BillingCurrency." This distinction helps differentiate when the column name is used in a general context versus the column Name ID, which is employed in normative statements.

The group agreed to create editorial guidelines to address this type of issues.

jpradocueva avatar May 23 '24 21:05 jpradocueva

Action Items from TF-1 call on October 1st:

  • [ ] TF1-#469 Joaquin, @jpradocueva : Prepare editorial guidelines reflecting agreed column naming conventions.

jpradocueva avatar Oct 01 '24 21:10 jpradocueva

PR #582 contains editorial guidelines to resolve this issue.

jpradocueva avatar Oct 02 '24 00:10 jpradocueva