Skip to content
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

pipenv-README seems cluttered at "Usage" #5280

Closed
dshah244 opened this issue Aug 22, 2022 · 1 comment
Closed

pipenv-README seems cluttered at "Usage" #5280

dshah244 opened this issue Aug 22, 2022 · 1 comment
Labels
Type: Documentation 📖 This issue relates to documentation of pipenv.

Comments

@dshah244
Copy link

dshah244 commented Aug 22, 2022

Bugfix: Documentation

I consider this issue as a Bug as nothing needs to be changed within the content of the README file.

Issue description

There are two stages within the README file where the content seems to be a bit cluttered. These can also be seen within the attached images. It seems that the content is not being rendered properly.

1

image

2

image

Expected result

I at least expect the CLI parameters to be mentioned as a list, with each one present in a new line.

Actual result

Neat and de-cluttered text rendered properly and presenting the various CLI options of pipenv.

Steps to replicate

It's visible in the "main" branch of the repository.

@dshah244 dshah244 changed the title pipenv-README seems cluttered at Usage pipenv-README seems cluttered at "Usage" Aug 22, 2022
@matteius matteius added the Type: Documentation 📖 This issue relates to documentation of pipenv. label Aug 22, 2022
@oz123
Copy link
Contributor

oz123 commented Aug 27, 2022

Thanks!

@oz123 oz123 closed this as completed Aug 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation 📖 This issue relates to documentation of pipenv.
Projects
None yet
Development

No branches or pull requests

3 participants