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.

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

Fix remote modules' PyPI documentation long description #326

Open
jhlegarreta opened this Issue Dec 18, 2018 · 2 comments

Comments

Projects
None yet
1 participant
@jhlegarreta
Copy link
Member

jhlegarreta commented Dec 18, 2018

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.

@jhlegarreta

This comment has been minimized.

Copy link
Member

jhlegarreta commented Dec 21, 2018

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

jhlegarreta added a commit to jhlegarreta/ITKPhaseSymmetry that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKIsotropicWavevelets that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKMorphologicalContourInterpolation that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKMinimalPathExtraction that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKMontage that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKHigherOrderAccurateGradient that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKFixedPointInverseDisplacementField that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKVariationalRegistration that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKTwoProjectionRegistration that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKStrain that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKPrincipalComponentsAnalysis that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKSmoothingRecursiveYvvGaussianFilter that referenced this issue Dec 21, 2018

C: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKVariationalRegistration that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKVariationalRegistration that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKParabolicMorphology that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKSplitComponents that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/LesionSizingToolkit that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKSplitComponents that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKMeshNoise that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKIOOpenSlide that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKFDFImageIO that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKIOTransformDCMTK that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKLabelErodeDilate that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

This comment has been minimized.

Copy link
Member

jhlegarreta commented Dec 21, 2018

I've gone through a good number of them.

dzenanz added a commit to InsightSoftwareConsortium/ITKMontage that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKStrain that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

hjmjohnson added a commit to KitwareMedical/ITKStrain that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKMinimalPathExtraction that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKMorphologicalContourInterpolation that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKMorphologicalContourInterpolation that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

dzenanz added a commit to KitwareMedical/ITKMorphologicalContourInterpolation that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

jhlegarreta added a commit to jhlegarreta/ITKMinimalPathExtraction that referenced this issue Dec 21, 2018

DOC: Improve Python package information.
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

dzenanz added a commit to InsightSoftwareConsortium/ITKMeshNoise that referenced this issue Dec 22, 2018

DOC: Improve Python package information.
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment