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

with enum descriptions #837

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

turbomam
Copy link
Member

No description provided.

@turbomam turbomam linked an issue Aug 13, 2024 that may be closed by this pull request
@turbomam
Copy link
Member Author

turbomam commented Aug 13, 2024

The change in mixs.yaml is too large to see.

example:

MoldVisibilityEnum:
    name: MoldVisibilityEnum
    description: 'permissible values, used by 5 terms: ceil_water_mold, door_water_mold,
      shad_dev_water_mold, wall_water_mold, window_water_mold'
    from_schema: https://w3id.org/mixs
    permissible_values:
      no presence of mold visible:
        text: no presence of mold visible
      presence of mold visible:
        text: presence of mold visible

@turbomam
Copy link
Member Author

I think we should add the document divider --- to the beginning of src/mixs/schema/deprecated.yaml, as suggested by [Unchanged files with check annotations](Unchanged files with check annotations)

We could double check with Sierra, or learn more about where that warning is coming from.

@turbomam
Copy link
Member Author

turbomam commented Aug 13, 2024

Future action: convert these enums and all of the schema to terser forms like

MoldVisibilityEnum:
    description: 'permissible values, used by 5 terms: ceil_water_mold, door_water_mold,
      shad_dev_water_mold, wall_water_mold, window_water_mold'
    permissible_values:
      no presence of mold visible:
      presence of mold visible: {}
  • remove redundant name and text keys
  • remove from_schema from auto-generation

@mslarae13
Copy link
Contributor

I did a quick check, and the additions to mixs.yaml looks good..

I think we should add the document divider --- to the beginning of src/mixs/schema/deprecated.yaml, as suggested by [Unchanged files with check annotations](Unchanged files with check annotations)

We could double check with Sierra, or learn more about where that warning is coming from.

I am good with that. But should do it in a separate PR & issue. As this one is specifically enum descriptions & that change is totally unrelated. Too much in 1 PR

Future action: convert these enums and all of the schema to terser forms like

MoldVisibilityEnum:
    description: 'permissible values, used by 5 terms: ceil_water_mold, door_water_mold,
      shad_dev_water_mold, wall_water_mold, window_water_mold'
    permissible_values:
      no presence of mold visible:
      presence of mold visible: {}
  • remove redundant name and text keys
  • remove from_schema from auto-generation

Good idea, @turbomam . Can we merge this in and make a separate issue for this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

Give enumerations boilerplate definitions for now
2 participants