Skip to content

Fix pydocstyle#208

Merged
felixhekhorn merged 4 commits into
masterfrom
improve-pydocstyle
Feb 16, 2024
Merged

Fix pydocstyle#208
felixhekhorn merged 4 commits into
masterfrom
improve-pydocstyle

Conversation

@Radonirinaunimi
Copy link
Copy Markdown
Member

@Radonirinaunimi Radonirinaunimi commented Jun 21, 2023

It was strongly advised before to fix the pydocstyle in the same way as what was done in NNPDF/eko#243 and hence the reason for this PR. I volunteered to do so and will do it incrementally, but everyone is invited to contribute.

  • yadism
    • coefficient_functions
    • esf
    • input
  • yadbox
    • runcards
  • yadmark
    • benchmark
    • data
    • navigator

@Radonirinaunimi Radonirinaunimi added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jun 21, 2023
@Radonirinaunimi Radonirinaunimi marked this pull request as draft June 21, 2023 20:36
@alecandido
Copy link
Copy Markdown
Collaborator

Thanks @Radonirinaunimi, it's an annoying task, but useful.

However, since part of the task really consists in reviewing the docstrings, I would suggest you not to target (necessarily) completion. Even reducing the amount of errors might be enough, and a significant improvement.

@Radonirinaunimi
Copy link
Copy Markdown
Member Author

Thanks @Radonirinaunimi, it's an annoying task, but useful.

However, since part of the task really consists in reviewing the docstrings, I would suggest you not to target (necessarily) completion. Even reducing the amount of errors might be enough, and a significant improvement.

Yes, indeed! That'd be exactly the plan.

@felixhekhorn
Copy link
Copy Markdown
Contributor

@Radonirinaunimi do you want to merge what is already here? just to not loose it? and convert the list into an issue?

@Radonirinaunimi
Copy link
Copy Markdown
Member Author

@Radonirinaunimi do you want to merge what is already here? just to not loose it? and convert the list into an issue?

My personal goal is to finish this before the Yadism paper appear. If that is not achieved, I agree that we can merge already what is here. But I haven't said my last words yet 😄

@felixhekhorn
Copy link
Copy Markdown
Contributor

better push for the paper itself 😇 or if you want to code, go for benchmarks

@Radonirinaunimi
Copy link
Copy Markdown
Member Author

better push for the paper itself 😇 or if you want to code, go for benchmarks

Absolutely! But this, if it will happen, will be for the outside hours.

@felixhekhorn felixhekhorn marked this pull request as ready for review February 16, 2024 13:46
@felixhekhorn felixhekhorn merged commit 3342c4b into master Feb 16, 2024
@felixhekhorn felixhekhorn deleted the improve-pydocstyle branch February 16, 2024 13:46
@felixhekhorn felixhekhorn mentioned this pull request Feb 16, 2024
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation good first issue Good for newcomers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants