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

Schema elements should have descriptions #813

Open
turbomam opened this issue Jul 3, 2024 · 4 comments · May be fixed by #826
Open

Schema elements should have descriptions #813

turbomam opened this issue Jul 3, 2024 · 4 comments · May be fixed by #826

Comments

@turbomam
Copy link
Member

turbomam commented Jul 3, 2024

See https://linkml.io/linkml/schemas/linter.html#recommended

And the description should follow some agreed-upon style guidelines

linkml-lint src/mixs/schema/mixs.yaml | grep "does not have recommended slot 'description'"
@turbomam
Copy link
Member Author

turbomam commented Jul 3, 2024

warning Slot 'soil_conductivity' does not have recommended slot 'description' (recommended)
warning Slot 'soil_pH' does not have recommended slot 'description' (recommended)
warning Slot 'water_pH' does not have recommended slot 'description' (recommended)

warning Enum 'AeroStrucEnum' does not have recommended slot 'description' (recommended)
warning Enum 'AnimalBodyCondEnum' does not have recommended slot 'description' (recommended)
warning Enum 'AnimalSexEnum' does not have recommended slot 'description' (recommended)
warning Enum 'ArchStrucEnum' does not have recommended slot 'description' (recommended)
warning Enum 'BinParamEnum' does not have recommended slot 'description' (recommended)
warning Enum 'BioticRelationshipEnum' does not have recommended slot 'description' (recommended)
warning Enum 'BuildingSettingEnum' does not have recommended slot 'description' (recommended)
warning Enum 'BuildDocsEnum' does not have recommended slot 'description' (recommended)
warning Enum 'BuildOccupTypeEnum' does not have recommended slot 'description' (recommended)
warning Enum 'BuiltStrucSetEnum' does not have recommended slot 'description' (recommended)
warning Enum 'CeilFinishMatEnum' does not have recommended slot 'description' (recommended)
warning Enum 'CeilStrucEnum' does not have recommended slot 'description' (recommended)
warning Enum 'CeilTypeEnum' does not have recommended slot 'description' (recommended)
warning Enum 'ComplApprEnum' does not have recommended slot 'description' (recommended)
warning Enum 'ContamScreenInputEnum' does not have recommended slot 'description' (recommended)
warning Enum 'CultResultEnum' does not have recommended slot 'description' (recommended)
warning Enum 'DeposEnvEnum' does not have recommended slot 'description' (recommended)
warning Enum 'DominantHandEnum' does not have recommended slot 'description' (recommended)
warning Enum 'DoorCompTypeEnum' does not have recommended slot 'description' (recommended)
warning Enum 'DoorDirectEnum' does not have recommended slot 'description' (recommended)
warning Enum 'DoorMatEnum' does not have recommended slot 'description' (recommended)
warning Enum 'DoorMoveEnum' does not have recommended slot 'description' (recommended)
warning Enum 'DoorTypeEnum' does not have recommended slot 'description' (recommended)
warning Enum 'DoorTypeMetalEnum' does not have recommended slot 'description' (recommended)
warning Enum 'DrainageClassEnum' does not have recommended slot 'description' (recommended)
warning Enum 'DrawingsEnum' does not have recommended slot 'description' (recommended)
warning Enum 'ExtrWeatherEventEnum' does not have recommended slot 'description' (recommended)
warning Enum 'FacilityTypeEnum' does not have recommended slot 'description' (recommended)
warning Enum 'FaoClassEnum' does not have recommended slot 'description' (recommended)
warning Enum 'FarmWaterSourceEnum' does not have recommended slot 'description' (recommended)
warning Enum 'FilterTypeEnum' does not have recommended slot 'description' (recommended)
warning Enum 'FireplaceTypeEnum' does not have recommended slot 'description' (recommended)
warning Enum 'FloorStrucEnum' does not have recommended slot 'description' (recommended)
warning Enum 'FloorWaterMoldEnum' does not have recommended slot 'description' (recommended)
warning Enum 'FoodCleanProcEnum' does not have recommended slot 'description' (recommended)
warning Enum 'FoodTraceListEnum' does not have recommended slot 'description' (recommended)
warning Enum 'FreqCleanEnum' does not have recommended slot 'description' (recommended)
warning Enum 'FurnitureEnum' does not have recommended slot 'description' (recommended)
warning Enum 'GenderRestroomEnum' does not have recommended slot 'description' (recommended)
warning Enum 'GrowthHabitEnum' does not have recommended slot 'description' (recommended)
warning Enum 'HandidnessEnum' does not have recommended slot 'description' (recommended)
warning Enum 'HcrEnum' does not have recommended slot 'description' (recommended)
warning Enum 'HcProducedEnum' does not have recommended slot 'description' (recommended)
warning Enum 'HeatCoolTypeEnum' does not have recommended slot 'description' (recommended)
warning Enum 'HeatSysDelivMethEnum' does not have recommended slot 'description' (recommended)
warning Enum 'HostCellularLocEnum' does not have recommended slot 'description' (recommended)
warning Enum 'HostDependenceEnum' does not have recommended slot 'description' (recommended)
warning Enum 'HostPredApprEnum' does not have recommended slot 'description' (recommended)
warning Enum 'HostSpecificityEnum' does not have recommended slot 'description' (recommended)
warning Enum 'IndoorSpaceEnum' does not have recommended slot 'description' (recommended)
warning Enum 'IndoorSurfEnum' does not have recommended slot 'description' (recommended)
warning Enum 'LibLayoutEnum' does not have recommended slot 'description' (recommended)
warning Enum 'LightTypeEnum' does not have recommended slot 'description' (recommended)
warning Enum 'LithologyEnum' does not have recommended slot 'description' (recommended)
warning Enum 'MagCovSoftwareEnum' does not have recommended slot 'description' (recommended)
warning Enum 'MechStrucEnum' does not have recommended slot 'description' (recommended)
warning Enum 'ModeTransmissionEnum' does not have recommended slot 'description' (recommended)
warning Enum 'NegContTypeEnum' does not have recommended slot 'description' (recommended)
warning Enum 'OccupDocumentEnum' does not have recommended slot 'description' (recommended)
warning Enum 'OxyStatSampEnum' does not have recommended slot 'description' (recommended)
warning Enum 'PlantReprodCropEnum' does not have recommended slot 'description' (recommended)
warning Enum 'PlantSexEnum' does not have recommended slot 'description' (recommended)
warning Enum 'PredGenomeStrucEnum' does not have recommended slot 'description' (recommended)
warning Enum 'ProfilePositionEnum' does not have recommended slot 'description' (recommended)
warning Enum 'QuadPosEnum' does not have recommended slot 'description' (recommended)
warning Enum 'RelSampLocEnum' does not have recommended slot 'description' (recommended)
warning Enum 'RelToOxygenEnum' does not have recommended slot 'description' (recommended)
warning Enum 'RoomCondtEnum' does not have recommended slot 'description' (recommended)
warning Enum 'RoomConnectedEnum' does not have recommended slot 'description' (recommended)
warning Enum 'RoomLocEnum' does not have recommended slot 'description' (recommended)
warning Enum 'RoomSampPosEnum' does not have recommended slot 'description' (recommended)
warning Enum 'RouteTransmissionEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SampCaptStatusEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SampCollectPointEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SampDisStageEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SampLocConditionEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SampSubtypeEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SampSurfMoistureEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SampTransportContEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SampWeatherEnum' does not have recommended slot 'description' (recommended)
warning Enum 'ScLysisApproachEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SeasonUseEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SedimentTypeEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SeqQualityCheckEnum' does not have recommended slot 'description' (recommended)
warning Enum 'ShadingDeviceLocEnum' does not have recommended slot 'description' (recommended)
warning Enum 'ShadingDeviceTypeEnum' does not have recommended slot 'description' (recommended)
warning Enum 'CompassDirections8Enum' does not have recommended slot 'description' (recommended)
warning Enum 'MoldVisibilityEnum' does not have recommended slot 'description' (recommended)
warning Enum 'DamagedRupturedEnum' does not have recommended slot 'description' (recommended)
warning Enum 'DamagedEnum' does not have recommended slot 'description' (recommended)
warning Enum 'CeilingWallTextureEnum' does not have recommended slot 'description' (recommended)
warning Enum 'GeolAgeEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SoilHorizonEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SoilTextureClassEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SortTechEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SpaceTypStateEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SpecificEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SrDepEnvEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SrKerogTypeEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SrLithologyEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SubstructureTypeEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SurfAirContEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SurfMaterialEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SymbiontHostRoleEnum' does not have recommended slot 'description' (recommended)
warning Enum 'SymLifeCycleTypeEnum' does not have recommended slot 'description' (recommended)
warning Enum 'TaxIdentEnum' does not have recommended slot 'description' (recommended)
warning Enum 'TidalStageEnum' does not have recommended slot 'description' (recommended)
warning Enum 'TillageEnum' does not have recommended slot 'description' (recommended)
warning Enum 'TrainLineEnum' does not have recommended slot 'description' (recommended)
warning Enum 'TrainStatLocEnum' does not have recommended slot 'description' (recommended)
warning Enum 'TrainStopLocEnum' does not have recommended slot 'description' (recommended)
warning Enum 'TrophicLevelEnum' does not have recommended slot 'description' (recommended)
warning Enum 'TypeOfSymbiosisEnum' does not have recommended slot 'description' (recommended)
warning Enum 'UrineCollectMethEnum' does not have recommended slot 'description' (recommended)
warning Enum 'UrobiomSexEnum' does not have recommended slot 'description' (recommended)
warning Enum 'VirusEnrichApprEnum' does not have recommended slot 'description' (recommended)
warning Enum 'WallConstTypeEnum' does not have recommended slot 'description' (recommended)
warning Enum 'WallFinishMatEnum' does not have recommended slot 'description' (recommended)
warning Enum 'WallSurfTreatmentEnum' does not have recommended slot 'description' (recommended)
warning Enum 'WaterFeatTypeEnum' does not have recommended slot 'description' (recommended)
warning Enum 'WeekdayEnum' does not have recommended slot 'description' (recommended)
warning Enum 'WgaAmpApprEnum' does not have recommended slot 'description' (recommended)
warning Enum 'WindowCoverEnum' does not have recommended slot 'description' (recommended)
warning Enum 'WindowHorizPosEnum' does not have recommended slot 'description' (recommended)
warning Enum 'WindowMatEnum' does not have recommended slot 'description' (recommended)
warning Enum 'WindowStatusEnum' does not have recommended slot 'description' (recommended)
warning Enum 'WindowTypeEnum' does not have recommended slot 'description' (recommended)
warning Enum 'WindowVertPosEnum' does not have recommended slot 'description' (recommended)

warning Subset 'combination_classes' does not have recommended slot 'description' (recommended)
warning Subset 'sequencing' does not have recommended slot 'description' (recommended)
warning Subset 'environment' does not have recommended slot 'description' (recommended)
warning Subset 'nucleic acid sequence source' does not have recommended slot 'description' (recommended)
warning Subset 'investigation' does not have recommended slot 'description' (recommended)

@turbomam turbomam changed the title Schema elements should have desriptions Schema elements should have descriptions Jul 3, 2024
@mslarae13 mslarae13 linked a pull request Jul 17, 2024 that will close this issue
@mslarae13 mslarae13 linked a pull request Jul 17, 2024 that will close this issue
@mslarae13
Copy link
Contributor

See #827 for

warning Slot 'soil_pH' does not have recommended slot 'description' (recommended)
warning Slot 'water_pH' does not have recommended slot 'description' (recommended)

@mslarae13
Copy link
Contributor

@turbomam is there any guidance on how Enum descriptions should be written? Should it mirror the slot the enum was made for?

@turbomam
Copy link
Member Author

turbomam commented Aug 8, 2024

Yeah, I guess so. I could even do a first pass programatically

"the enumeration of permissible values for the door_type slot"

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 a pull request may close this issue.

2 participants