Skip to content
This repository has been archived by the owner on Jan 10, 2023. It is now read-only.

Add documentation, Makefile, and linting #170

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

JeffLIrion
Copy link
Contributor

@JeffLIrion JeffLIrion commented Oct 18, 2019

There shouldn't be any breaking changes here, but this will create merge conflicts with most (if not all) outstanding pull requests.

Documentation and linting

More linting and documentation

usb_exceptions.py and the sign_*.py files pass linting checks

More linting and documentation

More linting and documentation

pylint: ignore too-few-public-methods

Spacing

Linting

Linting

Documentation

Linting

Create .readthedocs.yml
Create requirements.txt
Add documentation link to README
Update README.rst
Update README.rst
Update README.rst

Update .gitignore

Add call graphs

pylint and flake8 pass

Documentation

Documentation fixes

Add my Travis CI and Coveralls badges (#2)

Add some tables of contents to the documentation

Add linting to CI (#3)

* Add linting to CI

* Install flake8 and pylint

Hide the original repo's badges (for now) (#4)

Finish documentation skeletons for the sign_* files and usb_exceptions.py (#5)

Finish documentation skeletons for fastboot.py and fastboot_debug.py (#6)

Almost done with documentation skeletons

Finish documentation skeletons

Add contents to module docstrings

Working on documentation contents

Finish adding contents to module docstrings

Replace sections with rubrics

Document the sign_* modules and usb_exceptions.py

Remove whitespace

Fix typo

Add tests for the signers

Change 'ValueError' to more general 'Exception'

Added tests for the 'GetPublicKey()' methods

Add ADB keygen functionality (from @joeleong)

Fix sign_* tests

Add debugging code, work on documentation of filesync_protocol.py

Working on documentation

Remove debugging code

Fill in some documentation

Documentation and code formatting

Add some documentation

More documentation

Put command onto one line

Linting

Linting

Update documentation index.rst

Remove CHECKLIST.md
@coveralls
Copy link

coveralls commented Oct 18, 2019

Coverage Status

Coverage increased (+6.02%) to 49.735% when pulling ab99e77 on JeffLIrion:documentation into f4e597f on google:master.

@JeffLIrion JeffLIrion closed this Oct 19, 2019
@JeffLIrion JeffLIrion reopened this Oct 19, 2019
@JeffLIrion
Copy link
Contributor Author

I know that this pull request is pretty extensive and difficult to review. To help with this, I created two branches on my fork:

  • The master branch from this repo with comments removed and black code formatting
  • My documentation branch with comments removed and black code formatting

Here is a pull request from the latter to the former: https://github.com/JeffLIrion/python-adb/pull/7/files

If you look through the changes, you'll see that there are no breaking changes.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants