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

Add 'update' verb to the command #2

Open
3473f opened this issue Feb 15, 2023 · 0 comments · May be fixed by #48
Open

Add 'update' verb to the command #2

3473f opened this issue Feb 15, 2023 · 0 comments · May be fixed by #48
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@3473f
Copy link
Owner

3473f commented Feb 15, 2023

A new verb 'update' could be useful in two cases:

  • Extend the exiting package documentation
  • Update previously generated documentation in case of data type change or renaming

This also makes a good case for the improved document writer and the suggested use of a data structure in #1

[05.05.2024] Update:

#53 untangles the API and uses dictionaries as required by this PR

[31.03.2024] Update:

This will require a complete re-write of the code - the following should be implemented:

  • Use dictionary instead of lists to store interfaces. This will allow us to access by name instead of index, which is useful for the update verb
  • Seperate interface reading from the document writer. I had to create a DocWriter object inside the update method in order to get the node's interface, which is not clean.
@3473f 3473f added enhancement New feature or request good first issue Good for newcomers labels Feb 15, 2023
@3473f 3473f self-assigned this Feb 15, 2023
@3473f 3473f added good first issue Good for newcomers and removed good first issue Good for newcomers labels Feb 23, 2023
@3473f 3473f closed this as completed Aug 30, 2023
@3473f 3473f reopened this Mar 12, 2024
@3473f 3473f linked a pull request Mar 16, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant