Re: [DISCUSS] Applying D105 rule for our codebase ("undocumented magic methods") ?

2024-03-25 Thread Jarek Potiuk
-1 to enabling D105 >> >> >> >> >> >> I don't think it will lead to helpful documentation. I think for the >> rare >> >> cases it is required it can left up to the developer or caught in PR >> review. >> >> >> >> Cheers, >> >> Niko >> >&

Re: [DISCUSS] Applying D105 rule for our codebase ("undocumented magic methods") ?

2024-03-25 Thread Jarek Potiuk
> > >> ____________ > >> From: Vincent Beck > >> Sent: Wednesday, March 20, 2024 5:51:43 AM > >> To: dev@airflow.apache.org > >> Subject: RE: [EXTERNAL] [COURRIEL EXTERNE] [DISCUSS] Applying D105 rule > >> for our c

Re: [DISCUSS] Applying D105 rule for our codebase ("undocumented magic methods") ?

2024-03-25 Thread Wei Lee
w. >> >> Cheers, >> Niko >> >> >> From: Vincent Beck >> Sent: Wednesday, March 20, 2024 5:51:43 AM >> To: dev@airflow.apache.org >> Subject: RE: [EXTERNAL] [COURRIEL EXTERNE] [DISCUSS] Applying D105 rule >

Re: [DISCUSS] Applying D105 rule for our codebase ("undocumented magic methods") ?

2024-03-24 Thread Amogh Desai
per or caught in PR review. > > Cheers, > Niko > > > From: Vincent Beck > Sent: Wednesday, March 20, 2024 5:51:43 AM > To: dev@airflow.apache.org > Subject: RE: [EXTERNAL] [COURRIEL EXTERNE] [DISCUSS] Applying D105 rule > for our code

Re: [DISCUSS] Applying D105 rule for our codebase ("undocumented magic methods") ?

2024-03-20 Thread Oliveira, Niko
@airflow.apache.org Subject: RE: [EXTERNAL] [COURRIEL EXTERNE] [DISCUSS] Applying D105 rule for our codebase ("undocumented magic methods") ? CAUTION: This email originated from outside of the organization. Do not click links or open attachments unless you can confirm the sende

Re: [DISCUSS] Applying D105 rule for our codebase ("undocumented magic methods") ?

2024-03-20 Thread Vincent Beck
+1 for not enforcing as well. Let's leave to maintainers the flexibility to chose whether a given method should be documented. On 2024/03/20 08:28:51 Ash Berlin-Taylor wrote: > I'm for not enforcing this rule - as others have said its very unlikely to > result in more useful docs for

Re: [DISCUSS] Applying D105 rule for our codebase ("undocumented magic methods") ?

2024-03-20 Thread Ash Berlin-Taylor
I'm for not enforcing this rule - as others have said its very unlikely to result in more useful docs for developers or end users. -asg On 20 March 2024 08:12:40 GMT, Andrey Anshin wrote: >±0 from my side > >Maybe we have to review all current methods which do not follow this rule >to find a

Re: [DISCUSS] Applying D105 rule for our codebase ("undocumented magic methods") ?

2024-03-20 Thread Andrey Anshin
±0 from my side Maybe we have to review all current methods which do not follow this rule to find a really useful meaning, and do not enforce (disable it). So for avoid unnecessary changes we might close https://github.com/apache/airflow/issues/37523 and remove/mark completed into the

Re: [DISCUSS] Applying D105 rule for our codebase ("undocumented magic methods") ?

2024-03-20 Thread Pankaj Koti
+1 to what Aritra is saying. Best regards, *Pankaj Koti* Senior Software Engineer (Airflow OSS Engineering team) Location: Pune, Maharashtra, India Timezone: Indian Standard Time (IST) Phone: +91 9730079985 On Wed, Mar 20, 2024 at 12:05 PM Aritra Basu wrote: > I'm in general not a huge fan

Re: [DISCUSS] Applying D105 rule for our codebase ("undocumented magic methods") ?

2024-03-20 Thread Aritra Basu
I'm in general not a huge fan of documenting for the sake of documenting, so I'd be in agreement of not enforcing it via code but rather be enforced by the reviewers in cases they believe certain methods need documenting. -- Regards, Aritra Basu On Wed, Mar 20, 2024, 9:39 AM Jarek Potiuk wrote:

[DISCUSS] Applying D105 rule for our codebase ("undocumented magic methods") ?

2024-03-19 Thread Jarek Potiuk
Hey here, I wanted to quickly poll what people think about applying the https://docs.astral.sh/ruff/rules/undocumented-magic-method/ rule in our codebase. There are many uncontroversial rules - but that one is somewhat more controversial than others. See