Added A simple index #212
Closed
Added A simple index #212
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gridhead
requested review from
gridhead and
sdglitched
and removed request for
gridhead
gridhead
requested changes
Nov 6, 2024
Owner
gridhead
left a comment
gridhead
left a comment
There was a problem hiding this comment.
Thanks for the impromptu pull request.
Please make the following requested changes.
README.md
Outdated
|
|
||
|
|
||
|
|
||
| ## 📚 Index |
Owner
There was a problem hiding this comment.
The emojis might not be available on platforms like PyPI etc.
Suggested change
| ## 📚 Index | |
| ## Index |
Comment on lines
68
to
+70
|
|
||
|
|
||
|
|
Owner
There was a problem hiding this comment.
Please keep a maximum inter-section space of one newline.
Comment on lines
+79
to
+82
|
|
||
|
|
||
|
|
||
|
|
Owner
There was a problem hiding this comment.
Please keep a maximum inter-section space of one newline.
Comment on lines
+73
to
+78
| 1. **[Screenshots](#screenshots)** | ||
| 2. **[Download](#download)** | ||
| 3. **[Usage](#usage)** | ||
| 4. **[Development](#development)** | ||
| 5. **[Contribution](#contribution)** | ||
| 6. **[Disclaimer](#disclaimer)** |
Owner
There was a problem hiding this comment.
This does seem to work on GitHub but not on PyPI.
Owner
|
I do not see much use in this if it does not work on PyPI, as GitHub already seems to have a dedicated semantic outline feature for project documentation.
|
Contributor
Author
|
Please continue this discussion on pull request #213, Due to some technical error |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
@gridhead
I realize that it may not be essential, but I believed it was a useful and straightforward addition that could assist new users or visitors to the project.
Please let me know if you would like any changes.
I kept the index simple, but I can create a more detailed one if needed.
I like the idea of using emojis with the section headers; if you'd prefer, I can add them to all sections or remove them from the index.