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.

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

Jump to bottom

Default README format to Markdown in "new"? #280

Closed
1 task done
taion opened this issue Jul 5, 2018 · 4 comments
Closed
1 task done

Default README format to Markdown in "new"? #280

taion opened this issue Jul 5, 2018 · 4 comments
Assignees
@finswimmer
Labels
kind/feature Feature requests/implementations

Comments

@taion
Copy link

taion commented Jul 5, 2018

  • I have searched the issues of this repo and believe that this is not a duplicate.

Issue

When Markdown support was initially added in #15, Warehouse had somewhat questionable Markdown rendering. At this point, however, it appears that those issues have been resolved, and things like syntax highlighting now work.

As such, given the relative popularity of Markdown even for Python projects, it might make more sense for new to default to creating a README.md rather than a README.rst.
@cauebs cauebs mentioned this issue Jul 9, 2018
Closed
2 tasks
@brycedrennan brycedrennan added the kind/feature Feature requests/implementations label Aug 15, 2019
finswimmer pushed a commit to finswimmer/poetry that referenced this issue Oct 29, 2019
This PR implements python-poetry#280.
5396000 
**NEW**

* A new parameter called `--readme` for `poetry new` is introduced, which used for defining the README format. This can be set either to `md` or `rst`
* The readme is included in the `pyproject.toml`

**CHANGE**

* The default README format is now `.md`

**FIX**

* Test for `poetry new` is added
@finswimmer finswimmer mentioned this issue Oct 29, 2019
Closed
2 tasks
@finswimmer finswimmer self-assigned this Nov 24, 2019
abn added a commit to abn/poetry that referenced this issue Aug 6, 2020
@finswimmer @abn
layouts: add readme to pyproject.toml on creation
29c52b9 
Relates-to: python-poetry#280

Co-authored-by: Arun Babu Neelicattu <[email protected]>
abn added a commit to abn/poetry that referenced this issue Aug 6, 2020
@finswimmer @abn
command/new: make readme format configurable
80201d0 
This change makes readme formant configurable, defaulting to markdown
when using the new command.

Resolves: python-poetry#280
Closes: python-poetry#1515

Co-authored-by: Arun Babu Neelicattu <[email protected]>
@abn abn mentioned this issue Aug 6, 2020
Merged
abn added a commit to abn/poetry that referenced this issue Aug 27, 2020
@finswimmer @abn
layouts: add readme to pyproject.toml on creation
ab75ef7 
Relates-to: python-poetry#280

Co-authored-by: Arun Babu Neelicattu <[email protected]>
abn added a commit to abn/poetry that referenced this issue Aug 27, 2020
@finswimmer @abn
command/new: make readme format configurable
1d62ac9 
This change makes readme formant configurable, defaulting to markdown
when using the new command.

Resolves: python-poetry#280
Closes: python-poetry#1515

Co-authored-by: Arun Babu Neelicattu <[email protected]>
abn added a commit to abn/poetry that referenced this issue Sep 1, 2020
@finswimmer @abn
layouts: add readme to pyproject.toml on creation
6a318f2 
Relates-to: python-poetry#280

Co-authored-by: Arun Babu Neelicattu <[email protected]>
abn added a commit to abn/poetry that referenced this issue Sep 1, 2020
@finswimmer @abn
command/new: make readme format configurable
5ab216f 
This change makes readme formant configurable, defaulting to markdown
when using the new command.

Resolves: python-poetry#280
Closes: python-poetry#1515

Co-authored-by: Arun Babu Neelicattu <[email protected]>
abn added a commit to abn/poetry that referenced this issue Sep 22, 2020
@finswimmer @abn
layouts: add readme to pyproject.toml on creation
87fc8d5 
Relates-to: python-poetry#280

Co-authored-by: Arun Babu Neelicattu <[email protected]>
abn added a commit to abn/poetry that referenced this issue Sep 22, 2020
@finswimmer @abn
command/new: make readme format configurable
971a739 
This change makes readme formant configurable, defaulting to markdown
when using the new command.

Resolves: python-poetry#280
Closes: python-poetry#1515

Co-authored-by: Arun Babu Neelicattu <[email protected]>
@nanthony007
Copy link

This is a small issue I understand but has there been any resolution or progress on this? I would be open to contributing if needed.

@chemsaf3
Copy link

chemsaf3 commented Apr 3, 2021

any progress on this? seems like most use md due to github so may not know rst much, would make sense to change to md as default

@lovetoburnswhen
Copy link

Looks like there are a few open PRs that seem to work

abn added a commit to abn/poetry that referenced this issue Apr 9, 2021
@finswimmer @abn
layouts: add readme to pyproject.toml on creation
4516243 
Relates-to: python-poetry#280

Co-authored-by: Arun Babu Neelicattu <[email protected]>
abn added a commit to abn/poetry that referenced this issue Apr 9, 2021
@finswimmer @abn
command/new: make readme format configurable
81d4119 
This change makes readme formant configurable, defaulting to markdown
when using the new command.

Resolves: python-poetry#280
Closes: python-poetry#1515

Co-authored-by: Arun Babu Neelicattu <[email protected]>
abn added a commit to abn/poetry that referenced this issue Apr 10, 2021
@finswimmer @abn
layouts: add readme to pyproject.toml on creation
7ce029e 
Relates-to: python-poetry#280

Co-authored-by: Arun Babu Neelicattu <[email protected]>
abn added a commit to abn/poetry that referenced this issue Apr 10, 2021
@finswimmer @abn
command/new: make readme format configurable
152d720 
This change makes readme formant configurable, defaulting to markdown
when using the new command.

Resolves: python-poetry#280
Closes: python-poetry#1515

Co-authored-by: Arun Babu Neelicattu <[email protected]>
abn added a commit that referenced this issue Apr 12, 2021
@finswimmer @abn
layouts: add readme to pyproject.toml on creation
e9738b1 
Relates-to: #280

Co-authored-by: Arun Babu Neelicattu <[email protected]>
@abn abn closed this as completed in affabe0 Apr 12, 2021
dimbleby pushed a commit to dimbleby/poetry that referenced this issue Apr 21, 2022
@ali5h
sort package name in extras to make it reproducible (python-poetry#280)
0113a5a 
this fixes python-poetry#5125
@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 2, 2024

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@finswimmer finswimmer

Labels
kind/feature Feature requests/implementations
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Change README default format to Markdown and add it to pyproject.toml automatically
6 participants
@brycedrennan @finswimmer @taion @lovetoburnswhen @nanthony007 @chemsaf3