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

Issue #1155 Annotations conform to style guide #1160

Open
wants to merge 41 commits into
base: develop
Choose a base branch
from

Conversation

kstudzin
Copy link
Contributor

@kstudzin kstudzin commented Sep 17, 2024

This set of changes focuses on removing excess information from skos:definition and moving it to skos:example or skos:scopeNote. There is also some reformatting of all three annotations. However these changes do not attempt to make skos:definition full sentences where they are not. More changes will be added for this.

The definitions most significantly affected by removing examples are gist:Behavior and gist:Content. gist:Behavior maybe falls in the category "Occasionally a definition can hardly be understood at all without an example" of the style guide. My recommendation is that we try to make a more specific, full sentence definition, but we may determine that it is most clear to simply add the example back to the definition.

Our definition of gist:Content, in my opinion, was not a definition but rather a list of examples. I attempted to make a new definition, but would appreciate input on if this matches the existing usage. If there is other history on this definition and why we should include examples in the definition, that would also be helpful.

This set of changes focuses on removing excess information from
skos:definition and moving it to skos:example or skos:scopeNote.
There is also some reformatting of these three annotations.
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
docs/gistStyleGuide.md Outdated Show resolved Hide resolved
kstudzin and others added 23 commits September 18, 2024 10:04
Co-authored-by: Rebecca Younes <[email protected]>
Co-authored-by: Rebecca Younes <[email protected]>
Co-authored-by: Rebecca Younes <[email protected]>
Co-authored-by: Rebecca Younes <[email protected]>
Co-authored-by: Rebecca Younes <[email protected]>
Co-authored-by: Rebecca Younes <[email protected]>
Co-authored-by: Rebecca Younes <[email protected]>
Co-authored-by: Rebecca Younes <[email protected]>
Co-authored-by: Rebecca Younes <[email protected]>
Co-authored-by: Rebecca Younes <[email protected]>
Co-authored-by: Rebecca Younes <[email protected]>
Co-authored-by: Rebecca Younes <[email protected]>
Co-authored-by: Rebecca Younes <[email protected]>
Co-authored-by: Rebecca Younes <[email protected]>
Co-authored-by: Rebecca Younes <[email protected]>
Co-authored-by: Rebecca Younes <[email protected]>
Co-authored-by: Rebecca Younes <[email protected]>
Co-authored-by: Rebecca Younes <[email protected]>
Co-authored-by: Rebecca Younes <[email protected]>
Co-authored-by: Rebecca Younes <[email protected]>
Co-authored-by: Rebecca Younes <[email protected]>
Co-authored-by: Rebecca Younes <[email protected]>
Co-authored-by: Rebecca Younes <[email protected]>
Copy link
Contributor

@uscholdm uscholdm left a comment

Choose a reason for hiding this comment

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

Overall this is excellent, a big job and a painstaking one. I did make a bunch of suggestions.

Although this exercise was specifically to align definition style, I often gave in to the temptation to fix a bad definition, which might instead have been a separate issue warranting a group discussion.

I made changes for properties to style starting with 'relates'. But there were too many to attempt a fix for all of them.

ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
Copy link
Contributor

@dylan-sa dylan-sa left a comment

Choose a reason for hiding this comment

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

Agree with @uscholdm--this is great. A lot of much needed work. 👍

I've added some things that caught my eye.

ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
ontologies/gistCore.ttl Outdated Show resolved Hide resolved
Co-authored-by: Michael Uschold <[email protected]>
Co-authored-by: dylan-sa <[email protected]>
@kstudzin kstudzin marked this pull request as ready for review October 14, 2024 23:15
@kstudzin kstudzin requested a review from rjyounes October 14, 2024 23:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants