Make descriptions even more clear about gwadoc HOT 14 OPEN

from gwadoc.

from gwadoc.

Good 😃

Do you have a preference of the alternatives for the long definition? That is, whether the description maintains the focus on the concept or on the relation itself?

from gwadoc.

In that case I think the short definition should be adjusted to match. Perhaps, "When a concept is more specific than some given concept"

from gwadoc.

from gwadoc.

@gconnect @yoyo-go Can you both take note of the above discussion when working on the relations documentation? In particular:

• For short and long definitions, change "word" to "concept" and rephrase them to focus on the relation.

  For short definitions, it's probably as simple as putting "When" at the beginning and adjusting for grammaticality. E.g.:

  • "a word that is more specific than a given word" -> "when a concept is more specific than some given concept"

  But some may require more work. E.g.:

  • "an occurrence of something" -> "when a concept is an instance of some given concept"

  For long definitions, try to make the direction of the relation explicit. E.g.:

  • "A relation between two concepts where concept B is a type of concept A." -> "Hyponymy is a relation between concepts where A is a hyponym of B when A is a subtype of B."

• For examples, try to use the "(A) is a (relation) of (B)" when it fits. When it doesn't (e.g., 'see also'), we could find a precise way of stating the same thing (e.g., "(A) is in a see-also relation with (B)"), or propose a more natural alternative (e.g., "(A); see also (B)").

from gwadoc.

from gwadoc.

@gconnect @yoyo-go Can you both take note of the above discussion when working on the relations documentation? In particular:

• For short and long definitions, change "word" to "concept" and rephrase them to focus on the relation.
  For short definitions, it's probably as simple as putting "When" at the beginning and adjusting for grammaticality. E.g.:

  • "a word that is more specific than a given word" -> "when a concept is more specific than some given concept"

  But some may require more work. E.g.:

  • "an occurrence of something" -> "when a concept is an instance of some given concept"

  For long definitions, try to make the direction of the relation explicit. E.g.:

  • "A relation between two concepts where concept B is a type of concept A." -> "Hyponymy is a relation between concepts where A is a hyponym of B when A is a subtype of B."

• For examples, try to use the "(A) is a (relation) of (B)" when it fits. When it doesn't (e.g., 'see also'), we could find a precise way of stating the same thing (e.g., "(A) is in a see-also relation with (B)"), or propose a more natural alternative (e.g., "(A); see also (B)").

Thanks for that suggestion, I have revised the Domain relation groups and submitted the commit per your latest request.

from gwadoc.

@gconnect when you are checking this, can you also make sure the relations with tests in EWN are linked to the correct test, and link to the actual page (see what I did with attribute).

from gwadoc.

Alright. I will check what you did in Attribute and follow suit

from gwadoc.

I checked Attribute relations but can't seem to find what you did to link the correct test to the actual page.
Example will be helpful here.

from gwadoc.

Hi,

the short definitions are still not very harmonious.

You can easily seem the all from the new summary page (created as follows):
python build.py --lang en --object summary html > docs/summary.en.html

I think I would like to change the suggested template to something like:

• "one concept is more general than another concept"

so that it can be read as a definition

• a hypernym relation holds when "one concept is more general than another concept"

Note that umbrella terms like 'constitutive' may not follow this template and instance hypernymy is special, I have adjusted their definitions.

from gwadoc.

This is what I did for attribute:
pdf/EWN_general.pdf#page=24

The '#page=24' links to the page. You can find the example in the doc_en.py file.

from gwadoc.

Okay, I will check it again

from gwadoc.