Doc formatting cleanup #124
Merged
Conversation
This file contains 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
* Add inline code markup in places where it's missing. * Add trailing commas in example multiline param lists. * Adjust spacing and tab indent levels. * Migrate soft delete column final paragraphs up: Put them before talking about an updated-at column instead of after, so we're not randomly going back to a previous topic. * Quote strings in code markup to make it clear that they are strings.
Couldn't quite figure out how to do it for the HTML at the start of index.md, but still an improvement.
* Fix incorrect indent levels. * Apply correct/standard formatting to paginated docstrings. * Docstring formatting fixes for fastcrud and endpoint. * Quote strings in code markup to make it clear that they are strings.
slaarti
added a commit
to slaarti/fastcrud
that referenced
this pull request
Jul 15, 2024
This is a possible correction to igorbenav#124: `mkdocs` complains about not recognizing the relative links' destination. The recommendation it provides didn't quite make sense to me relative to the URL structure as rendered, but it apparently automatically substituted it in and it appeared to work, so I just left them as I'd written them. Now, I realize now that it may be more about the actual structure of the filesystem getting from `api/fastcrud.md` (which contains the includes from the code's docstrings) to `advanced/crud.md`, and `mkdocs` handles translating the file paths to URLs. So I put this PR together to fix the links and you can figure out whether or not it needs to go in. :D
3 tasks
slaarti
added a commit
to slaarti/fastcrud
that referenced
this pull request
Jul 17, 2024
This is a possible correction to igorbenav#124: `mkdocs` complains about not recognizing the relative links' destination. The recommendation it provides didn't quite make sense to me relative to the URL structure as rendered, but it apparently automatically substituted it in and it appeared to work, so I just left them as I'd written them. Now, I realize now that it may be more about the actual structure of the filesystem getting from `api/fastcrud.md` (which contains the includes from the code's docstrings) to `advanced/crud.md`, and `mkdocs` handles translating the file paths to URLs. So I put this PR together to fix the links and you can figure out whether or not it needs to go in. :D
slaarti
added a commit
to slaarti/fastcrud
that referenced
this pull request
Jul 25, 2024
This is a possible correction to igorbenav#124: `mkdocs` complains about not recognizing the relative links' destination. The recommendation it provides didn't quite make sense to me relative to the URL structure as rendered, but it apparently automatically substituted it in and it appeared to work, so I just left them as I'd written them. Now, I realize now that it may be more about the actual structure of the filesystem getting from `api/fastcrud.md` (which contains the includes from the code's docstrings) to `advanced/crud.md`, and `mkdocs` handles translating the file paths to URLs. So I put this PR together to fix the links and you can figure out whether or not it needs to go in. :D
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Preliminary to work I've been doing for #72, this PR is to some cleanup of the docs and docstrings, mostly in terms of consistency in formatting. See the Changes section for more details.
Changes
index.md, but still an improvement.)paginated/docstrings.Tests
There are no code changes, and therefore no changes to tests.
Checklist