search

ionelmc / pytest-benchmark

py.test fixture for benchmarking code
BSD 2-Clause "Simplified" License
1.24k stars 119 forks source link

Remove 'See calibration_ and FAQ_.' from project summary #181

Closed mcsitter closed 4 years ago

mcsitter commented 4 years ago

It would be awesome if 'See calibration and FAQ.' could be removed from the description in setup.py. I could not find a place in which the links would work, but they get shown everywhere, where there is the description of the project, such as on the project page on pypi and the current plugin list of pytest, which is getting reworked as of pytest-dev/pytest#5105 .

before:

    description='A ``pytest`` fixture for benchmarking code. It will group the tests into rounds that are calibrated to the chosen timer. '
                'See calibration_ and FAQ_.',

after:

    description='A ``pytest`` fixture for benchmarking code. It will group the tests into rounds that are calibrated to the chosen timer. ',

It is also in the README.rst and .cookiecutterrc. I can understand if updating the cookiecutter details and the docs is undesired, but i see no problem in updating the package metadata.

I would be happy to open a PR if you agree with this proposal!

ionelmc commented 4 years ago

Those are named references, I guess there's a problem with those. We could convert those to regular links to the latest docs - would that work in the plugin list?

mcsitter commented 4 years ago

I think it would work for the plugin list, but the project page would be become really ugly. I don't think they render the description for the header here. It is probably just the text. summary in Realease database model

ionelmc commented 4 years ago

Alright fine, lets just remove them.