Skip to content

Add pydoclint#2469

Merged
Adel-Moumen merged 25 commits into
speechbrain:developfrom
pplantinga:add-pydoclint
Mar 27, 2024
Merged

Add pydoclint#2469
Adel-Moumen merged 25 commits into
speechbrain:developfrom
pplantinga:add-pydoclint

Conversation

@pplantinga

@pplantinga pplantinga commented Mar 21, 2024

Copy link
Copy Markdown
Collaborator

Adds pydoclint extension to flake8 for docstring linting.

  • Fix docstrings in recipes
  • Fix docstrings in speechbrain
  • Fix docstrings in templates
  • Fix docstrings in tests

@pplantinga pplantinga marked this pull request as ready for review March 26, 2024 03:01

@Adel-Moumen Adel-Moumen left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @pplantinga,

Thanks for this PR! This is a really nice addition to SB. I went through the first 130 files (and now it start to be a bit painful since I need to "load diff" each file in the GitHub interface), but everything looks good so far.

I only left 1-2 comments but overall this is great and we should move on with this PR. Thanks again.

Comment thread recipes/LJSpeech/TTS/vocoder/hifi_gan_unit/train.py
Comment thread recipes/LibriSpeech/ASR/transformer/train_with_whisper.py
@Adel-Moumen

Copy link
Copy Markdown
Collaborator

One thing that comes into my mind is that we should also make sure to update https://github.com/speechbrain/benchmarks as well.

@Adel-Moumen Adel-Moumen merged commit d4c9f39 into speechbrain:develop Mar 27, 2024
@pplantinga pplantinga deleted the add-pydoclint branch March 27, 2024 22:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants