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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Fix documentation issues mentioned in static analysis #411

Open
camilamaia opened this issue Jun 21, 2021 · 0 comments 路 Fixed by #427
Open

Fix documentation issues mentioned in static analysis #411

camilamaia opened this issue Jun 21, 2021 · 0 comments 路 Fixed by #427
Labels
Code Quality Impacts the code quality: tests, logs, alerts... Documentation Improvements or additions to documentation Good First Issue Good for newcomers or first time contributors. Multi Contributors Multiple Contributors can work on the issue.

Comments

@camilamaia
Copy link
Member

Feature request

Description of the feature

To increase the quality of the project we are using static analysis to find out documentation issues in the project.

A detailed list of the issues can be found here

馃挕 The Issue requires multiple PRs so more than one person can contribute to the issue.
@camilamaia camilamaia added Needs Triage Needs triage from the maintainer or core devs. Code Quality Impacts the code quality: tests, logs, alerts... Documentation Improvements or additions to documentation Good First Issue Good for newcomers or first time contributors. and removed Needs Triage Needs triage from the maintainer or core devs. labels Jun 21, 2021
This was referenced Jun 21, 2021
Merged
Closed
@camilamaia camilamaia mentioned this issue Jun 30, 2021
Closed
marcorichetta added a commit that referenced this issue Jul 24, 2021
@marcorichetta
Fix: Docstrings converted to single-line
76078b6 
- Docstrings fits in a single line according to PEP8.
- Reference https://deepsource.io/gh/scanapi/scanapi/issue/FLK-D200/occurrences

Fixes #411
@marcorichetta marcorichetta mentioned this issue Jul 24, 2021
Merged
7 tasks
camilamaia pushed a commit that referenced this issue Jul 26, 2021
@marcorichetta
Fix: Docstrings converted to single-line (#427)
ccfb432 
* Fix: Docstrings converted to single-line

- Docstrings fits in a single line according to PEP8.
- Reference https://deepsource.io/gh/scanapi/scanapi/issue/FLK-D200/occurrences

Fixes #411

* Fix: doc line need to be <= 80 characters
@camilamaia camilamaia reopened this Jul 26, 2021
@Pradhvan Pradhvan added the Multi Contributors Multiple Contributors can work on the issue. label Jul 29, 2021
This was referenced Jul 30, 2021
Closed
Open
Closed
Closed
Closed
Open
@Saransh-cpp Saransh-cpp mentioned this issue Sep 30, 2021
Closed
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Code Quality Impacts the code quality: tests, logs, alerts... Documentation Improvements or additions to documentation Good First Issue Good for newcomers or first time contributors. Multi Contributors Multiple Contributors can work on the issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix: Docstrings converted to single-line scanapi/scanapi
2 participants
@camilamaia @Pradhvan