Skip to content

api: Add a display property to all components #272

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: mainline
Choose a base branch
from
Open

api: Add a display property to all components #272

wants to merge 1 commit into from

Conversation

ajCameron
Copy link
Collaborator

New human readable properties have been added at the top level of each object

Pros

  • more straightforward - each method is clear and up front
  • helps emphasize their importance - we'll reserve properties such as "name" for human readable options - magic methods for devs
  • emphasizes the importance of human readability
  • very clear

Cons

  • less elegant - methods are somewhat cluttered with options
  • arguably less clear
  • means people need to focus on business logic and display logic at the same time

@ajCameron ajCameron force-pushed the feature-human_readable_component_additions branch from e662809 to 9015eca Compare December 14, 2023 00:54
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions

55.6% Coverage on New Code (required ≥ 80%)

See analysis details on SonarCloud

@ajCameron ajCameron changed the title api: Add a display property to all components - Option 1 api: Add a display property to all components Jan 22, 2024
@ajCameron @javajawa
Add human-oriented describer methods to the Component Contract
7394a9d 
The following have been added to the Component interfaces:
 - Help
 - Description
 - Display Name
 - Status
@javajawa javajawa force-pushed the feature-human_readable_component_additions branch from b893567 to 7394a9d Compare January 22, 2024 09:02
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions

55.6% Coverage on New Code (required ≥ 80%)

See analysis details on SonarCloud

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@ajCameron