Giter Club home page Giter Club logo

Comments (3)

goodmami avatar goodmami commented on July 18, 2024

Thanks for the detailed report! We recently concluded a documentation push where we, among other things, tried to standardize the A/B vs X/Y things, but it seems like we've missed some. Similarly, we had issues with the description being the reverse of what they should be. It seems there is still a lot of work to do.

from gwadoc.

simongray avatar simongray commented on July 18, 2024

NP!

If I may make one suggestion it would be to always have a representation of the actual directionality somewhere in the entry, i.e.

A -> B

(... or whatever triple representation you favour) which makes it clear which part A is referring to and which part B is referring to.

Then you can flip this relationship for the entry describing the reverse relationship:

B -> A

and reuse the entity names so they still reflect the same entity types, that is: use them as backreferences. This would also allow you to reuse many of the written descriptions for the reverse relationships.

However, without a consistent codification of the relationships inside the entries, the descriptions are quite useless and it actually becomes very hard to spot the errors.

from gwadoc.

goodmami avatar goodmami commented on July 18, 2024

That's a good idea. Sometimes the directionality is confusing even when the wording is correct.

from gwadoc.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.