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

Added documentation of how to handle code changes. #920

Merged
merged 6 commits into from
Aug 16, 2024
Merged

Conversation

jesper-friis
Copy link
Collaborator

Description

This is an initial suggestion that should be reviewed.

When agreed, the suggested API should be implemented.

Type of change

  • Bug fix & code cleanup
  • New feature
  • Documentation update
  • Test update

Checklist for the reviewer

This checklist should be used as a help for the reviewer.

  • Is the change limited to one issue?
  • Does this PR close the issue?
  • Is the code easy to read and understand?
  • Do all new feature have an accompanying new test?
  • Has the documentation been updated as necessary?

This is an initial suggestion that should be reviewed.
@jesper-friis jesper-friis marked this pull request as draft August 12, 2024 14:10
Copy link
Contributor

@torhaugl torhaugl left a comment

Choose a reason for hiding this comment

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

Added some suggestions

doc/contributors_guide/code_changes.md Outdated Show resolved Hide resolved
doc/contributors_guide/code_changes.md Show resolved Hide resolved
doc/contributors_guide/code_changes.md Show resolved Hide resolved
doc/contributors_guide/code_changes.md Outdated Show resolved Hide resolved
jesper-friis and others added 3 commits August 13, 2024 09:45
Co-authored-by: Tor S. Haugland <torshaugland@gmail.com>
Co-authored-by: Tor S. Haugland <torshaugland@gmail.com>
@jesper-friis jesper-friis marked this pull request as ready for review August 16, 2024 14:36
@jesper-friis jesper-friis merged commit c96db68 into master Aug 16, 2024
13 checks passed
@jesper-friis jesper-friis deleted the code_changes branch August 16, 2024 14:41
jesper-friis added a commit that referenced this pull request Aug 16, 2024
Implemented the formalised code changes described in PR #920.

**Benefits**: Make it possible to improve our control over code changes. Provide predictability for when changes will happen and give users a time-span to a given versions number to adapt to new changes.

* Improved deprecation warnings and initial implementation of behavior.
* Added a simple Python class for accessing behavior from Python
* Added Python interface to behaviours.
* Added initialisation of behavior table and simplified the logics.
* Fixed a bug in natoi()
* Fix documentation strings.
* Documented environment variables DLITE_BEHAVIOR_*
* Added more instructions to warning in dlite_behavior_get()

---------

Co-authored-by: Francesca L. Bleken <48128015+francescalb@users.noreply.github.com>
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