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 internal documentation #58

Merged
merged 3 commits into from
Nov 4, 2023
Merged

add internal documentation #58

merged 3 commits into from
Nov 4, 2023

Conversation

amtoine
Copy link
Owner

@amtoine amtoine commented Nov 4, 2023

after discussing with @stormasm a bit about the make-cache command, i thought we could add some internal documentation, not too much but just enough to make sense 😋

changelog

  • rename make-cache to clean-cache-dir to hopefully make more sense
  • sanitize the paths given to add-to-cache, save-cache and remove-from-cache => the paths given to them were not always sanitized, this should help make this sanitization more consistent
  • add some documentation to the internal commands, for when we'll have true LSP support 😉
    • on the biggest thing is telling from the outside whether a path is sanitized or not

@amtoine amtoine added documentation Improvements or additions to documentation enhancement New feature or request core Related to the main `nu-git-manager` module labels Nov 4, 2023
@melMass melMass merged commit 4935705 into main Nov 4, 2023
@melMass melMass deleted the add-internal-documentation branch November 4, 2023 15:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Related to the main `nu-git-manager` module documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants