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.

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

Warn about outdated content & misc. housekeeping & slicing/caching docs #14

Merged
merged 17 commits into from
Nov 23, 2023

Conversation

FliegendeWurst
Copy link
Member

@FliegendeWurst FliegendeWurst commented Oct 24, 2023

Rendered

- devel/ProofLoadSave.md
- devel/NewKeyParser.md
Copy link
Member Author

Choose a reason for hiding this comment

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

Related: #12

@FliegendeWurst FliegendeWurst changed the title Warn about outdated content & misc. housekeeping Warn about outdated content & misc. housekeeping & slicing/caching docs Nov 4, 2023
Copy link
Member

@WolframPfeifer WolframPfeifer left a comment

Choose a reason for hiding this comment

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

Thanks for updates and clean-up!

I think we should keep the old documentation for now (How2ExtRecoder), as Recoder is still part of the project and the documentation might still be helpful for understanding it. I do not know if we have it somewhere else.

Maybe it would also make sense to move the caching documentation to a different PR, since I do not want to have it in the docs until it is actually implemented in KeY that way ...

docs/changelog.md Show resolved Hide resolved
docs/user/HowToTaclet.md Show resolved Hide resolved
pyproject.toml Outdated
Copy link
Member

Choose a reason for hiding this comment

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

What is this file used for?

Copy link
Member Author

Choose a reason for hiding this comment

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

It specifies the dependencies required by mkdocs. Some new dependency management tools for Python can use this file to automatically set up a dev environment.

But it would certainly be a good idea to unify the dependency info. I think there are at least three different places they are specified at the moment..

@WolframPfeifer WolframPfeifer merged commit 405ed0b into KeYProject:master Nov 23, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants