Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reduce max line length for tutorials #241

Merged
merged 6 commits into from
Nov 13, 2023
Merged

Conversation

RLKRo
Copy link
Member

@RLKRo RLKRo commented Oct 3, 2023

Description

Code from tutorials often doesn't fit inside the generated codeblocks and users have to scroll in order to read them.
This PR reduces max-line-length for tutorial files.

Max line length for flake8 is not reduced because it also complains about strings and comments exceeding max line length. But I did go through every line it complained (with lowered line length) and ensured that it was ok not to fix them.

Also, a bit out of scope of this PR but it got in my way so this PR fixes an issue with flake completely ignoring many files by adding per-file-ignores instead of flake8: noqa.

Checklist

  • I have covered the code with tests
  • I have added comments to my code to help others understand it
  • I have updated the documentation to reflect the changes
  • I have performed a self-review of the changes

@RLKRo RLKRo added the documentation Improvements or additions to documentation label Oct 3, 2023
RLKRo added 3 commits October 3, 2023 03:07
# Conflicts:
#	tutorials/script/core/7_pre_response_processing.py
Flake was also complaining about the length of comments and strings which are displayed properly in the docs. And blake is enough to ensure that code fits in the docs.

Line limit decreased because some strings were still not fitting.

And also `flake: noqa: E402` doesn't work -- that line disables all quality assurance for that file so instead `per-file-ignores` are added.
@RLKRo RLKRo marked this pull request as ready for review November 6, 2023 21:53
@RLKRo RLKRo merged commit a2a1c58 into dev Nov 13, 2023
16 checks passed
@RLKRo RLKRo deleted the docs/reduce-tutorial-max-line-length branch November 13, 2023 11:07
@RLKRo RLKRo mentioned this pull request Nov 21, 2023
1 task
RLKRo added a commit that referenced this pull request Nov 21, 2023
Release v0.6.3

# Release notes

- Update README to make it more concise and include reasons to use DFF (#281)
- Add [DFF optimization guide](https://deeppavlov.github.io/dialog_flow_framework/user_guides/optimization_guide.html) (#236)
- Add documentation section description for the [index page](https://deeppavlov.github.io/dialog_flow_framework/index.html) (#281)
- Add async method [dff.messengers.common.interface.CallbackMessengerInterface.on_request_async](https://deeppavlov.github.io/dialog_flow_framework/apiref/dff.messengers.common.interface.html#dff.messengers.common.interface.CallbackMessengerInterface.on_request_async) (#206)
- Move information about messenger interfaces from `pipeline.6_custom_messenger_interface` (removed) to [messengers.web_api_interface.1_fastapi](https://deeppavlov.github.io/dialog_flow_framework/tutorials/tutorials.messengers.web_api_interface.1_fastapi.html) (#206)
- Fix cross-references in [dff.messengers.common.interface](https://deeppavlov.github.io/dialog_flow_framework/apiref/dff.messengers.common.interface.html) (#206)
- Update tutorials to fit into documentation without side-scrolling (#241)
@RLKRo RLKRo mentioned this pull request Dec 10, 2023
4 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant