Skip to content

Maint ad docs#763

Merged
vlipovac merged 7 commits intodevelopfrom
maint-ad-docs
Nov 14, 2022
Merged

Maint ad docs#763
vlipovac merged 7 commits intodevelopfrom
maint-ad-docs

Conversation

@vlipovac
Copy link
Contributor

@vlipovac vlipovac commented Nov 9, 2022

As discussed with @keileg , in order to establish the new workflow with regards to the docs branch, here an update to docstrings and type annotations of some AD classes and functions.
(src code synchronization with docs).

Types of changes

  • Minor change (e.g., dependency bumps, broken links, etc).
  • Bugfix (non-breaking change which fixes an issue).
  • New feature (non-breaking change which adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • Testing (contribution related to testing of existing or new functionality).
  • Documentation (contribution related to adding, improving, or fixing documentation).
  • Maintenance (e.g., improve logic and performance, remove obsolete code, etc).
  • Other:

Checklist

Put an x in the boxes that apply or explain briefly why the box is not relevant.

  • The documentation is up-to-date.
  • Static typing is included in the update.
  • This PR does not duplicated existing functionality.
  • The update is covered by the test suite (including tests added in the PR).

@vlipovac vlipovac added the documentation Issue/PR related to documentation. label Nov 9, 2022
@vlipovac vlipovac self-assigned this Nov 9, 2022
Copy link
Contributor

@keileg keileg left a comment

Choose a reason for hiding this comment

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

One minor comment. Besides: Thanks!

@vlipovac
Copy link
Contributor Author

@keileg are the mypy issues still present?
The checks here fail in unchanged files.

@IvarStefansson
Copy link
Contributor

@keileg are the mypy issues still present? The checks here fail in unchanged files.

Checks pass on develop. So updating from develop should suffice.

@vlipovac
Copy link
Contributor Author

@keileg are the mypy issues still present? The checks here fail in unchanged files.

Checks pass on develop. So updating from develop should suffice.

My bad, there was a return type annotation which was not in develop and which caused mistakes in the discretization file.

@vlipovac vlipovac merged commit 958a55d into develop Nov 14, 2022
@vlipovac vlipovac deleted the maint-ad-docs branch November 14, 2022 09:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Issue/PR related to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants