Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Description/Author formatting in tutorials/pyproject-toml.md #193

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
Merged
merged 10 commits into from
Mar 6, 2024
Merged

Description/Author formatting in tutorials/pyproject-toml.md #193

merged 10 commits into from
Mar 6, 2024

Conversation

sneakers-the-rat
Copy link
Contributor

Currently, putting the author and maintainer all on one line makes it hard to read, and spill of the page even with the page maximized on my laptop - the example of the quirk is not visible :(

Screenshot 2024-03-01 at 2 15 22 PM Screenshot 2024-03-01 at 2 15 39 PM

Reformatted the author and description throughout so that it looks like this:
Screenshot 2024-03-01 at 2 17 42 PM

I also

  • Added a note on a "description" - there is already a nice note on the relationship between the TOML tables and arrays and python data objects, so I previewed that by saying "multiline strings are also the same" and otherwise the description doesn't get introduced
  • Modified the authors and maintainers to illustrate the concept - two initial authors, but then one of them drops out and then we gain a new friend. I think them being the same is a lil confusing

@sneakers-the-rat sneakers-the-rat mentioned this pull request Mar 4, 2024
Closed
lwasser
lwasser approved these changes Mar 6, 2024
View reviewed changes
Copy link
Member

@lwasser lwasser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @sneakers-the-rat we can merge this. it looks really nice now! the ci issue relate to html proofer not liking hashed links to a part of a page on pypa and a few other issues unrelated to this pr. let's go ahead and merge this!

@lwasser lwasser merged commit 717be65 into pyOpenSci:main Mar 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lwasser lwasser lwasser approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@sneakers-the-rat @lwasser