Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[EDITORIAL] Column doc link formatting fix #469

Conversation

AWS-ZachErdman
Copy link
Contributor

@AWS-ZachErdman AWS-ZachErdman commented May 21, 2024

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.

Fixed inconsistent spacing in column name links. Also fixed a link to ContractedUnitPrice that incorrectly linked to the glossary.
@AWS-ZachErdman AWS-ZachErdman requested a review from a team as a code owner May 21, 2024 21:56
@AWS-ZachErdman AWS-ZachErdman changed the title Column doc link formatting fix [EDITORIAL] Column doc link formatting fix May 21, 2024
@jpradocueva jpradocueva added the editorial Items that address editorial and minor changes label May 23, 2024
@jpradocueva jpradocueva added this to the v1.1 milestone May 23, 2024
Copy link
Contributor

@jpradocueva jpradocueva left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should Numeric Format be updated?

@AWS-ZachErdman
Copy link
Contributor Author

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.

@jpradocueva
Copy link
Contributor

@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.

@AWS-ZachErdman
Copy link
Contributor Author

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

@jpradocueva
Copy link
Contributor

jpradocueva commented May 23, 2024

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 jpradocueva reopened this May 23, 2024
@jpradocueva jpradocueva self-assigned this May 23, 2024
@jpradocueva jpradocueva added the consistency/review Consistency Review label Sep 28, 2024
@jpradocueva
Copy link
Contributor

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

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

@jpradocueva
Copy link
Contributor

PR #582 contains editorial guidelines to resolve this issue.

@jpradocueva jpradocueva closed this Oct 2, 2024
@jpradocueva jpradocueva deleted the Fixing-formatting-of-links-to-specific-columns branch October 4, 2024 00:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
consistency/review Consistency Review editorial Items that address editorial and minor changes
Projects
Status: Closed
Development

Successfully merging this pull request may close these issues.

2 participants