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

Add missing docstrings in network_service module #357

Merged
merged 26 commits into from
Aug 6, 2024
Merged

Add missing docstrings in network_service module #357

merged 26 commits into from
Aug 6, 2024

Conversation

sajith
Copy link
Member

@sajith sajith commented Aug 5, 2024

Resolves #314.

sajith added 26 commits July 9, 2024 17:41
@sajith
Add docstring to NetworkService class
8ed2125
@sajith
Add docstring to NetworkService.get_pretty_name_dict()
5b479b7
@sajith
Add docstring to NetworkService.get_fablib_manager()
0347bc8
@sajith
Add docstring to NetworkService.get_site()
18f376f
@sajith
Add docstring to NetworkService.get_sliver()
5cd9ae8
@sajith
Add docstring to NetworkService.get_fim()
cdd6a5d
@sajith
Merge remote-tracking branch 'origin/main' into 314.network-service-d…
2dbafae 
…ocstrings
@sajith
Add docstrings to NetworkService.{set,get}_user_data()
8a9fa7a
@sajith
Fix sphinx warning on NetworkService.config()
d039757 
Warning is: "docstring of fabrictestbed_extensions.fablib.network_service.NetworkService.config:3:Unexpected indentation"
@sajith
Add docstrings to NetworkService.{add,remove}_interface()
0f38f60
@sajith
Fix a sphinx warning
8e4fece 
Warning is: "docstring of fabrictestbed_extensions.fablib.resources.Resources.update:3:Unexpected indentation"
@sajith
Reformat NetworkService.set_instantiated() docstring
4b937ec
@sajith
Reformat NetworkService.show() docstring
a1fb5e0
@sajith
Add docstring to NetworkService.delete()
60d82e2
@sajith
Add docstrings to NetworkService.{get,set}_fablib_data()
579cd6b
@sajith
Add docstrings to NetworkService.set_{subnet,gateway}()
02533a8
@sajith
Add docstring to NetworkService.get_allocated_ips()
c0a7455
@sajith
Add docstring to NetworkService.set_allocated_ip()
4d4650f
@sajith
Add docstring to NetworkService.allocate_ip()
5fe93ff
@sajith
Add docstring to NetworkService.set_allocated_ips()
bc17658
@sajith
Add docstring to NetworkService.free_ip()
90a27d1
@sajith
Add docstring to NetworkService.make_ip_publicly_routable()
5e4b9c3
@sajith
Add docstring to NetworkService.init_fablib_data()
3dbfa14
@sajith
Add docstring to NetworkService.is_instantiated()
ceb1280
@sajith
Merge remote-tracking branch 'origin/main' into 314.network-service-d…
e1c01e1 
…ocstrings
@sajith
Update changelog
d4b266c
@coveralls
Copy link
Collaborator

Pull Request Test Coverage Report for Build 10257064339

Details

  • 1 of 1 (100.0%) changed or added relevant line in 1 file are covered.
  • 6 unchanged lines in 1 file lost coverage.
  • Overall coverage increased (+0.008%) to 17.5%
Files with Coverage Reduction New Missed Lines %
fabrictestbed_extensions/fablib/network_service.py 6 13.27%
Totals Coverage Status
Change from base Build 10255617361: 0.008%
Covered Lines: 1351
Relevant Lines: 5589
💛 - Coveralls

@sajith sajith requested review from paul-ruth and kthare10 August 6, 2024 15:50
kthare10
kthare10 approved these changes Aug 6, 2024
View reviewed changes
Copy link
Collaborator

@kthare10 kthare10 left a comment

Choose a reason for hiding this comment

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

looks good

@sajith sajith merged commit f3fe3de into main Aug 6, 2024
19 checks passed
@sajith sajith deleted the 314.network-service-docstrings branch August 6, 2024 16:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kthare10 kthare10 kthare10 approved these changes

@paul-ruth paul-ruth Awaiting requested review from paul-ruth

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add missing function docstrings in fablib.network_service
3 participants
@sajith @coveralls @kthare10