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.

Sign up for GitHub

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

Jump to bottom

New feature: self documenting models #243

Merged
merged 45 commits into from
Jan 27, 2021
Merged

New feature: self documenting models #243

merged 45 commits into from
Jan 27, 2021

Conversation

fwitte
Copy link
Member

@fwitte fwitte commented Jan 11, 2021

This PR introduces self documenting TESPy models. The goal is facilitating documentation of your TESPy models and to improve transparency of the documentation of such models. The feature will be shipped with the upcoming release but will still be in development.

@pep8speaks

This comment has been minimized.

Sign in to view
@fwitte
Copy link
Member Author

fwitte commented Jan 11, 2021

  • Apply changes on connections
  • Apply changes on busses
  • Create default report layout
  • Update What's New

@lgtm-com
Copy link

lgtm-com bot commented Jan 11, 2021

This pull request fixes 1 alert when merging 81145ae into 4aecead - view on LGTM.com

fixed alerts:

  • 1 for Unused import

@lgtm-com
Copy link

lgtm-com bot commented Jan 13, 2021

This pull request introduces 14 alerts and fixes 1 when merging 01abd9a into 4aecead - view on LGTM.com

new alerts:

  • 11 for Unused import
  • 2 for Signature mismatch in overriding method
  • 1 for __init__ method calls overridden method

fixed alerts:

  • 1 for Unused import

@lgtm-com
Copy link

lgtm-com bot commented Jan 16, 2021

This pull request introduces 20 alerts and fixes 1 when merging 75a3034 into 4aecead - view on LGTM.com

new alerts:

  • 12 for Unused import
  • 4 for Unused local variable
  • 2 for Signature mismatch in overriding method
  • 1 for First parameter of a method is not named 'self'
  • 1 for __init__ method calls overridden method

fixed alerts:

  • 1 for Unused import

@fwitte
Update all component classes
2201698 
- Add LaTeX code for all equations
- Remove unnecessary methods
- Remove class Node
- Split char_map of compressor into separate methods
- Add some bus documentation functions
- Add method to check bus domain errors
@fwitte
Add plotting, delete CompressorMap and remove z2 from CharMap
8818c05
@fwitte
Update version number
7202276
@fwitte
Update documentation to new API
21d0803
@fwitte
Update What's New
92675b2
@fwitte
Adjustments to new API, add document_model method
0749e4e
@fwitte
Update the tests
b604ae3
@lgtm-com
Copy link

lgtm-com bot commented Jan 26, 2021

This pull request introduces 33 alerts and fixes 1 when merging b604ae3 into 4aecead - view on LGTM.com

new alerts:

  • 21 for Unused import
  • 8 for Unused local variable
  • 2 for Signature mismatch in overriding method
  • 1 for Variable defined multiple times
  • 1 for __init__ method calls overridden method

fixed alerts:

  • 1 for Unused import

@lgtm-com
Copy link

lgtm-com bot commented Jan 26, 2021

This pull request introduces 4 alerts and fixes 1 when merging 2eea6ad into 4aecead - view on LGTM.com

new alerts:

  • 2 for Signature mismatch in overriding method
  • 1 for Variable defined multiple times
  • 1 for __init__ method calls overridden method

fixed alerts:

  • 1 for Unused import

@lgtm-com
Copy link

lgtm-com bot commented Jan 26, 2021

This pull request introduces 3 alerts and fixes 1 when merging d918f10 into 4aecead - view on LGTM.com

new alerts:

  • 2 for Signature mismatch in overriding method
  • 1 for __init__ method calls overridden method

fixed alerts:

  • 1 for Unused import

@fwitte fwitte merged commit 103f2ee into dev Jan 27, 2021
@lgtm-com
Copy link

lgtm-com bot commented Jan 27, 2021

This pull request introduces 3 alerts and fixes 1 when merging 0b51ae0 into 4aecead - view on LGTM.com

new alerts:

  • 2 for Signature mismatch in overriding method
  • 1 for __init__ method calls overridden method

fixed alerts:

  • 1 for Unused import

@fwitte fwitte deleted the feature/self_documenting_models branch February 18, 2021 12:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@fwitte @pep8speaks