Skip to content

Commit a4f4fea

Browse files
Use one sentence per line in documentation (#1911)
1 parent 9b672c5 commit a4f4fea

4 files changed

Lines changed: 19 additions & 29 deletions

File tree

‎CODE_OF_CONDUCT.rst‎

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,9 @@ Our Standards
1111

1212
Examples of behavior that contributes to creating a positive environment include:
1313

14-
Using welcoming and inclusive language
15-
Being respectful of differing viewpoints and experiences
16-
Gracefully accepting constructive criticism
17-
Focusing on what is best for the community
18-
Showing empathy towards other community members
19-
Examples of unacceptable behavior by participants include:
20-
21-
The use of sexualized language or imagery and unwelcome sexual attention or advances
22-
Trolling, insulting/derogatory comments, and personal or political attacks
23-
Public or private harassment
24-
Publishing others' private information, such as a physical or electronic address, without explicit permission
25-
Other conduct which could reasonably be considered inappropriate in a professional setting
26-
Our Responsibilities
14+
Using welcoming and inclusive language Being respectful of differing viewpoints and experiences Gracefully accepting constructive criticism Focusing on what is best for the community Showing empathy towards other community members Examples of unacceptable behavior by participants include:
15+
16+
The use of sexualized language or imagery and unwelcome sexual attention or advances Trolling, insulting/derogatory comments, and personal or political attacks Public or private harassment Publishing others' private information, such as a physical or electronic address, without explicit permission Other conduct which could reasonably be considered inappropriate in a professional setting Our Responsibilities
2717

2818
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
2919

@@ -32,12 +22,17 @@ Project maintainers have the right and responsibility to remove, edit, or reject
3222
Scope
3323
-----
3424

35-
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
25+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
26+
Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
27+
Representation of a project may be further defined and clarified by project maintainers.
3628

3729
Enforcement
3830
-----------
3931

40-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at adamdangoor@gmail.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
32+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at adamdangoor@gmail.com.
33+
All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances.
34+
The project team is obligated to maintain confidentiality with regard to the reporter of an incident.
35+
Further details of specific enforcement policies may be posted separately.
4136

4237
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
4338

‎README.rst‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -66,11 +66,8 @@ VWS and Query APIs
6666
Model Target Web API
6767
~~~~~~~~~~~~~~~~~~~~
6868

69-
The `Model Target Web API`_ authenticates with OAuth2 client credentials
70-
rather than the VWS signature scheme. This package builds the HTTP Basic
71-
header for the ``POST /oauth2/token`` request and the ``Bearer`` header for
72-
the dataset endpoints; making the token request, and caching the returned
73-
token, are left to you.
69+
The `Model Target Web API`_ authenticates with OAuth2 client credentials rather than the VWS signature scheme.
70+
This package builds the HTTP Basic header for the ``POST /oauth2/token`` request and the ``Bearer`` header for the dataset endpoints; making the token request, and caching the returned token, are left to you.
7471

7572
.. code-block:: python
7673

‎docs/source/index.rst‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,11 @@ VWS and Query APIs
6262
Model Target Web API
6363
~~~~~~~~~~~~~~~~~~~~
6464

65-
The `Model Target Web API`_ does not use the signature scheme which
66-
``authorization_header`` implements. It authenticates with OAuth2 client
67-
credentials: a ``POST /oauth2/token`` request with HTTP Basic credentials
68-
and a ``grant_type=client_credentials`` form body returns a bearer token,
69-
which is then sent to the dataset endpoints.
70-
71-
This package builds the headers only. Making the token request, and
72-
caching the returned token until it expires, are left to you.
65+
The `Model Target Web API`_ does not use the signature scheme which ``authorization_header`` implements.
66+
It authenticates with OAuth2 client credentials: a ``POST /oauth2/token`` request with HTTP Basic credentials and a ``grant_type=client_credentials`` form body returns a bearer token, which is then sent to the dataset endpoints.
67+
68+
This package builds the headers only.
69+
Making the token request, and caching the returned token until it expires, are left to you.
7370

7471
.. code-block:: python
7572

‎newsfragments/1908.change.rst‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
Drop Python 3.13 support. Python 3.14 or later is now required, allowing development installs to use PyTorch-free ``vws-python-mock`` releases.
1+
Drop Python 3.13 support.
2+
Python 3.14 or later is now required, allowing development installs to use PyTorch-free ``vws-python-mock`` releases.

0 commit comments

Comments
 (0)