Yicong-Huang commented on PR #5000:
URL: https://github.com/apache/texera/pull/5000#issuecomment-4421648010

   No, I mean syncing source code and the doc. 
   
   Say in the future I open a new PR adding a new operator, but forget to add a 
doc section, is there a mechanism to alert me? Similarly, say I open a PR to 
change csv operator's parameters, is there a mechanism to alert me?
   
   We want to make sure the docs are in sync with the source code. To do that, 
usually we use source code to generate docs, and use CI to verify that the docs 
are generates from source. 
   
   What we have now does not look like generated from source code. This will 
easier drift in the future. In fact, I don't know if the docs are aligned with 
what we have in source code, right now.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to