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

docs: document new configuration.markdown.copyFiles.destination options #203391

Conversation

mrienstra
Copy link
Contributor

And clean-up / standardize existing docs of same.

Continuation of #193752.

Changes:

extensions/markdown-language-features/package.nls.json

  1. Changed order of documented variables to match extensions/markdown-language-features/src/languageFeatures/copyFiles/copyFiles.ts.
  2. Consistent documentation of all variables, using /Users/me/myProject/docs/README.md as the example Markdown document.

Before:

  • ${documentFileName} — The full filename of the Markdown document, for example: readme.md.
  • ${documentBaseName} — The basename of Markdown document, for example: readme.
  • ${documentExtName} — The extension of the Markdown document, for example: md.
  • ${documentDirName} — The name of the Markdown document's parent directory.
  • ${documentWorkspaceFolder} — The workspace folder for the Markdown document, for example: /Users/me/myProject. This is the same as ${documentDirName} if the file is not part of a workspace.
  • ${fileName} — The file name of the dropped file, for example: image.png.

After:

  • ${documentDirName} — Absolute parent directory path of the Markdown document, e.g. /Users/me/myProject/docs.
  • ${documentRelativeDirName} — Relative parent directory path of the Markdown document, e.g. docs. This is the same as ${documentDirName} if the file is not part of a workspace.
  • ${documentFileName} — The full filename of the Markdown document, e.g. README.md.
  • ${documentBaseName} — The basename of the Markdown document, e.g. README.
  • ${documentExtName} — The extension of the Markdown document, e.g. md.
  • ${documentFilePath} — Absolute path of the Markdown document, e.g. /Users/me/myProject/docs/README.md.
  • ${documentRelativeFilePath} — Relative path of the Markdown document, e.g. docs/README.md. This is the same as ${documentFilePath} if the file is not part of a workspace.
  • ${documentWorkspaceFolder} — The workspace folder for the Markdown document, e.g. /Users/me/myProject. This is the same as ${documentDirName} if the file is not part of a workspace.
  • ${fileName} — The file name of the dropped file, e.g. image.png.
  • ${fileExtName} — The extension of the dropped file, e.g. png.

extensions/markdown-language-features/src/languageFeatures/copyFiles/copyFiles.ts

Updated inline comments to match the new variable descriptions I added to extensions/markdown-language-features/package.nls.json. I caught a minor issue (albeit unlikely to trip anyone up) -- the comment after documentRelativeDirName was // Absolute parent directory path (copied unchanged from line above) -- figured I might as well just sync them up while I was at it.

And clean-up / standardize existing docs of same
Copy link
Collaborator

@mjbvz mjbvz left a comment

Choose a reason for hiding this comment

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

Thanks!

@mjbvz mjbvz added this to the December / January 2024 milestone Jan 25, 2024
@mjbvz mjbvz enabled auto-merge (squash) January 25, 2024 00:17
@mjbvz mjbvz merged commit dc10e26 into microsoft:main Jan 25, 2024
6 checks passed
@mrienstra mrienstra deleted the description-of-configuration.markdown.copyFiles.destination-patch branch January 25, 2024 00:57
@microsoft microsoft locked and limited conversation to collaborators Jun 10, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants