-
-
Notifications
You must be signed in to change notification settings - Fork 316
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
docs: restructuralize examples - move all of them into a dedicated dir #4815
base: main
Are you sure you want to change the base?
Conversation
I'm just including Markus as we are finishing off a big documentation transition, and thus to make sure it is covered correctly and accounted for in the transition (for work possibly already done or tested without this change) |
The commit in talk is the already-merged ab90c5e, right? I have merged |
That's correct.
Great, thanks for taking care of the conflicts. |
There is still a linting issue: MARKDOWN
2024-12-19 09:43:49 [INFO] Linting MARKDOWN items...
Error: -19 09:43:52 [ERROR] Found errors when linting MARKDOWN. Exit code: 1.
2024-12-19 09:43:52 [INFO] Stderr contents for MARKDOWN:
------
/github/workspace/doc/examples/notebooks/README.md:8:81 MD013/line-length Line length [Expected: 80; Actual: 91] |
Yes. The only reason it pops up now is that the original file contained it and it was moved now (without edits). It is not introduced by this PR, it is just that the linter finally got to check the file. I guess it should therefore be fixed in a separate PR (this one should not modify files unless necessary) -> I'll prepare a chore one that should be merged before this one. |
The PR with the line length fix was merged, so there's a small conflict here to solve (copy the changed file again here) |
Merged into the PR. Markdown issues solved. But there are still issues with some Python code - some of the moved Python example modules have their description too long.
Is there any way to handle this? I found many places like this throughout the repository but none of them seemed to have to deal with this so far. They are just ticking ticking ticking timebombs waiting for a new commit to activate them (all of them seemed to be modified before the linter was introduced). |
|
Create directory
docs/examples
and move the following directories inside:docs/gui
docs/notebooks
docs/python
docs/raster
docs/vector