potiuk commented on PR #32519:
URL: https://github.com/apache/airflow/pull/32519#issuecomment-1693010055

   > However, even if that is not possible, I think it is a good idea to 
supplement the inconsistency for historical reasons in comments etc. so that 
"current" users are not confused.
   
   Sure, now that you know it and got detailed explanation - I think you are 
one of the best people to determing where users like you would look for such 
comments and can add it. And I am really saying it because I believe it, not 
because I want to "frame you".  Things are often obvious to maintainers, 
because they have years of experience and  lots of assumptions they "soaked" 
for years. So they have often no idea that things like that should be 
documented, nor they have idea how and where users like you would look for this 
information. And what kind of information is needed.
   
   Airflow is created by ~ 2600 contributors. Vast majority of those people are 
people like you who found they are missing something and contributed it back.
   
   So now - since you got detailed explanation, you are probably the best 
person in the world to turn it in the comments - in the right places and the 
right wording that would be for good for people like you to understand when 
they are puzzled about something. Maybe even it should be explained in the 
documentation of ours (And it is super easy to add PR to documentation - just 
click on "Suggest a change on this page" and PR will be opened for you. This 
way you can become a contributor, give back for the free software you are using 
and generally get even more familiar with the code, structure, documentation 
building etc.
   
   So - absolutely - you are more than welcome, after all that explanation to 
submit a PR to update the comment and docs. And even if you do not get it right 
in your first PR, the reviewers will comment, review, suggest and explain more 
- so that's even better opportunity to learn why things are the way they are. 
   
   And this could be the same for any other aspect that is not clear. The 
people who are seeking for answers and do not find them are probaby the best 
people who can word and find the right places where the answers should be given 
- precisely in the places they were looking for them and did not find them.
   
   I sincerely look forward for this and possibly other future PRs with 
clarification that those discussions and your curiosity might bring.


-- 
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