GitHub user Yicong-Huang added a comment to the discussion: UX Feedback (Operator Descriptions)
I think this is a really important issue. We should make the documentation show up as closely as possible on the UI. I support reviewing the existing operators and improving their inline documentation. At the same time, the documentation/description should remain concise so users aren’t overwhelmed by unnecessary detail. Humen are lazy and they all want TL;DR. A related principle is: “If a variable needs extensive documentation, it may be better to rename it.” Improving how self-explanatory the interface is should also be one of our goals. If an operator property is difficult to explain clearly and concisely, we should consider revising its name or redesigning the property itself rather than relying solely on extensive documentation. GitHub link: https://github.com/apache/texera/discussions/6798#discussioncomment-17774055 ---- This is an automatically sent email for [email protected]. To unsubscribe, please send an email to: [email protected]
