Uh oh!
There was an error while loading. Please reload this page.
docs: fix 18 typos in model docstrings and VMware sample - #89
Open
Avicennasis wants to merge 1 commit into
Open
Conversation
Corrects spelling errors in model docstrings (perferred, correponding, Agnet, user_ecryption_key, magento) and in the VMware sample script (ot, prtection, duplicated 'added' in a print statement). Documentation and one sample print string only; no API behaviour changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes 18 spelling/typo issues across 5 files. Documentation strings and one sample-script
printonly - no API behaviour, field names, or identifiers were changed.cohesity_management_sdk/models/io_preferential_tier.py(10)perferred->preferred(9 occurrences in the class docstring)correponding->correspondingcohesity_management_sdk/models/registered_app_info.py(1)'AgnetRunning'->'AgentRunning'- the docstring lists example host-settings check names; the real enum incheck_type_enum.py/host_settings_check_result.pyiskIsAgentRunning, so this was a plain misspelling in prose, not a real value.cohesity_management_sdk/models/update_application_server_parameters.py(2) andregister_application_servers_parameters.py(2)'user_ecryption_key'->'user_encryption_key'- no field by either name exists in the SDK (the real attribute isencryption_key/encryptionKey), and the following sentence already says "user encryption key", so this is prose.internal magento key->internal magneto key- "Magneto" is the Cohesity component (80 files in this repo referencemagneto, includingmagneto_object_id.pyandmagneto_instance_id.py);magentoappears only 3 times and is the e-commerce platform. The same docstring already says "internal magneto key" two attributes later, so this makes the paragraph self-consistent.samples/vmware/create_protect_vms.py(3)Test method ot get VMs->Test method to get VMsprtection job is already protecting->protection job is already protectingprint("Successfully added VMs added to protection job.")->print("Successfully added VMs to protection job.")- duplicated word in the output string. This is the only occurrence in the repo; no tests assert on it.Note for reviewers
magentoalso appears once incohesity_management_sdk/models/register_protection_source_parameters.py, which was outside the scope of this change - happy to include it if you'd like.