Skip to content

Titles consistently in sentence case #126

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
takluyver merged 1 commit into from
May 27, 2018
Merged

Titles consistently in sentence case #126

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions _practicalities/intro.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ upgrade.

## As a user

### Install Pip 9.0
### Install pip 9.0

If you are already a Python 3 user, you should not encounter a lot of
disruption. Please still check that the libraries you use follow best practices
Expand Down Expand Up @@ -172,7 +172,7 @@ this](https://github.com/pypa/pypi-legacy/pull/506).
Thus as long as your user have recent enough versions of pip and setuptools
they will get the right version of your library.

# Unit Testing and documentation
# Unit testing and documentation

It is recommended **not** to invoke `setup.py` directly either with `install` or
`develop` subcommands. These may not correctly resolve dependencies, and can
Expand All @@ -182,7 +182,7 @@ install .` and `pip install -e .` for regular and developer installs, respectiv
Check in scripts and documentation that the correct installation command is
used.

# Recommended Mitigations
# Recommended mitigations

These are not mandatory but should make the transition seamless by warning your
users early enough _and_ providing useful error messages.
Expand Down Expand Up @@ -273,7 +273,7 @@ The regular expression to check for validity of pep440 can be found below:
(\\.dev(0|[1-9]\\d*))?


## fail early in setup.py
## Fail early in setup.py

Leave `setup.py` python 2 compatible and fail early. If you detect Python 2
raise a clear error message and ask the user to make sure they have pip > 9.0 (or
Expand All @@ -296,7 +296,7 @@ and that you will hear about. This is an attempt to acknowledge them, and
explain why they can't work and what are their drawbacks before you attempt to
implement them.

### Use a meta-package.
### Use a meta-package

It is possible to release a meta-package that has _virtually_ no code and relies
on a conditional dependency to install its actual core code on the user system.
Expand Down Expand Up @@ -329,16 +329,16 @@ publish multiple sdist of a package targeting various python version.
It is not possible anymore to upload multiple sdist files on PyPI, so this
solution is no longer tenable.

### Wheel only ?
### Wheel only?

Releasing a package only using wheels for a given python version is doable, but
this will break downstream packages that may require the original source to
reproduce their build.

# Why all *this* ?!?
# Why all *this*?!?

You might wonder why all this, it's 2018 already, so how come this is still an
issue? Python 3 has been out for 9+ years now !
issue? Python 3 has been out for 9+ years now!

Well there are many reasons for this. First of all, this issue mostly affects
libraries that are currently python 2 and Python 3 compatible at the same time.
Expand Down