updates docs

Author: moisesguimaraes

.gitignore

@@ -41,6 +41,7 @@ htmlcov/
 .coverage
 .coverage.*
 .cache
+.pytest_cache
 nosetests.xml
 coverage.xml
 *,cover
@@ -67,3 +68,6 @@ venv_2.7
 venv_3.4
 venv_3.5
 venv_3.6
+
+# code editor preferences
+.vscode

Makefile

@@ -49,8 +49,9 @@ clean-test: ## remove test and coverage artifacts
 
 lint: ## check style with flake8
 	flake8 src tests
+	pylint src tests/*
 
-test: ## run tests quickly with the default Python
+test: install ## run tests quickly with the default Python
 	py.test tests
 
 check: test ## run tests quickly with the default Python
@@ -60,8 +61,8 @@ test-all: ## run tests on every Python version with tox
 
 check-all: test-all ## run tests on every Python version with tox
 
-coverage: ## check code coverage quickly with the default Python
-	coverage run --source wolfssl -m pytest
+cov: install ## check code coverage quickly with the default Python
+	py.test --cov-config .coveragerc --cov=wolfssl tests
 	coverage report -m
 	coverage html
 	$(BROWSER) htmlcov/index.html
@@ -71,6 +72,10 @@ docs: install ## generate Sphinx HTML documentation, including API docs
 	$(MAKE) -C docs singlehtml
 	$(BROWSER) docs/_build/singlehtml/index.html
 
+doctest: install ## generate Sphinx HTML documentation, including API docs
+	$(MAKE) -C docs clean
+	$(MAKE) -C docs doctest
+
 servedocs: docs ## compile the docs watching for changes
 	watchmedo shell-command -p '*.rst' -c '$(MAKE) -C docs html' -R -D .
 

src/wolfssl/__init__.py

@@ -602,6 +602,10 @@ def wrap_socket(sock, keyfile=None, certfile=None, server_side=False,
         Which connections succeed will vary depending on the versions of the
         ssl providers on both sides of the communication.
 
+    Note 2:
+        For TLS 1.3 connections use PROTOCOL_TLS as there is no dedicated
+        PROTOCOL constant for just TLS 1.3.
+
     The ciphers parameter sets the available ciphers for this SSL object. It
     should be a string in the wolfSSL cipher list format.