Fix remote modules' PyPI documentation long description #326

jhlegarreta · 2018-12-18T01:25:33Z

Description

Fix the Python Package Index (PyPI) remote module documentation long description.

Steps to Reproduce

Check that the project long description in a remote module's setup.py file has white spaces for each new line.

To check the effect of missing white spaces at the end of the line, look for a remote-module whose Python package has been uploaded to the PyPI, e.g. ITKPhaseSymmetry, or more generally, looking for keywords such as itk. Then verify that the missing white spaces makes two consecutive line words to be concatenated.

Even if the module has not been uploaded to PyPI, all remotes (look for the itk-module tag in GitHub) must be fixed.

Expected behavior

A module's long description must be a well-written sentence.

Actual behavior

Words at the end of a line and at the beginning of the other are concatenated.

Reproducibility

Always.

Versions

All.

Environment

Any

Additional Information

Each remote will need to be cloned locally, fixed, and a PR opened for each.

The text was updated successfully, but these errors were encountered:

jhlegarreta · 2018-12-21T01:00:50Z

Another related issue is that the packages are named differently wrt to the counterpart ITK project names: lower cases are used and a dash separates the module name from itk

Improve Python package information: - Make the reference in the long description match the package name and not the ITK project name. - Use white spaces to avoid words in two consecutive lines being concatenated. Partially addresses: InsightSoftwareConsortium/ITK#326

Improve Python package information: - Make the reference in the long description match the package name and not the ITK project name. - Use white spaces to avoid words in two consecutive lines being concatenated. - Format the IJ journal reference mentioning the URL in the last place. - Minot ortopgrahy correction. Partially addresses: InsightSoftwareConsortium/ITK#326

Improve Python package information: - Provide a short description. - Make the reference in the long description match the package name and not the ITK project name. - Replace the generic ITK long description for a description of the package. - Make the URL be the URL of the project in GitHub. - Add kewyowrds. Partially addresses: InsightSoftwareConsortium/ITK#326

Improve Python package information: - Make the reference in the long description match the package name and not the ITK project name. - Replace the generic ITK long description for a description of the package. - Make the URL be the URL of the project in GitHub. Partially addresses: InsightSoftwareConsortium/ITK#326

Improve Python package information: - Make the reference in the long description match the package name and not the ITK project name. - Replace the generic ITK long description for a description of the package. - Make the URL be the URL of the project in GitHub. - Add kewyowrds. Partially addresses: InsightSoftwareConsortium/ITK#326

Improve Python package information: - Make the reference in the long description match the package name and not the ITK project name. - Use white spaces to avoid words in two consecutive lines being concatenated. - Prefer ASCII inverted commas. Partially addresses: InsightSoftwareConsortium/ITK#326

Improve Python package information: - Replace the generic ITK long description for a description of the package. - Make the URL be the URL of the project in GitHub. - Add kewyowrds. Partially addresses: InsightSoftwareConsortium/ITK#326

Improve Python package information: - Make the reference in the long description match the package name and not the ITK project name. - Use white spaces to avoid words in two consecutive lines being concatenated. - Prefer ASCII double inverted commas. Partially addresses: InsightSoftwareConsortium/ITK#326

Improve Python package information: - Make the reference in the long description match the package name and not the ITK project name. - Use white spaces to avoid words in two consecutive lines being concatenated. Partially addresses: InsightSoftwareConsortium/ITK#326

Improve Python package information: - Make the reference in the long description match the package name and not the ITK project name. - Use white spaces to avoid words in two consecutive lines being concatenated. - Add keywords. Partially addresses: InsightSoftwareConsortium/ITK#326

jhlegarreta · 2018-12-21T04:25:54Z

I've gone through a good number of them.