Skip to content

Commit

Permalink
docs: rename document to "Project Guidelines"
Browse files Browse the repository at this point in the history
  • Loading branch information
lars-reimann committed Jul 10, 2023
1 parent d3d6010 commit 2e96f51
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/development/code_review.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,6 @@ preferably one with a cat image.
If you found any problems,
select `Request Changes` instead.

[guidelines-general]: guidelines.md
[guidelines-tests]: guidelines.md#tests
[guidelines-general]: project_guidelines.md
[guidelines-tests]: project_guidelines.md#tests
[github-review]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Guidelines
# Project Guidelines

This document describes general guidelines for the Safe-DS Python Library. In the **DO**/**DON'T** examples below we either show _client code_ to describe the code users should/shouldn't have to write, or _library code_ to describe the code we, as library developers, need to write to achieve readable client code. We'll continuously update this document as we find new categories of usability issues.

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ nav:
- Glossary: glossary.md
- Development:
- Environment: development/environment.md
- Project Guidelines: development/guidelines.md
- Project Guidelines: development/project_guidelines.md
- Contributing: https://github.com/Safe-DS/Stdlib/contribute
- Code Review Guide: development/code_review.md

Expand Down

0 comments on commit 2e96f51

Please sign in to comment.