Giter Club home page Giter Club logo

Comments (4)

flossypurse avatar flossypurse commented on June 14, 2024 1

I think the best solution right now is to make sure there are comments directly in the proto file and then we can link to that file in Github. I created a Notion page to collect the comments.

from documentation.

flossypurse avatar flossypurse commented on June 14, 2024

Just an update here -
I tried to use Snipsync here as a quick win.
However, proto file linters don't like comments at the end of the files:
temporalio/api#108

So, options are:

  • Find a way to add an exception to the linter to work with Snipsync
  • Alter Snipsync such that it only needs an opening wrapper somehow
  • Just link directly to that file from the docs and add informational comments inline to the file (need to do this to use Snipsync anyways)
  • Duplicate the list and document the events in another file somewhere

from documentation.

swyxio avatar swyxio commented on June 14, 2024

i think for our purposes we can just do 3 or 4 for now, and if we figure out how to do 1 or 2 in future we can double back

from documentation.

flossypurse avatar flossypurse commented on June 14, 2024

Done!
#296

from documentation.

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.