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

Improve documentation of constants #1330

Merged
merged 1 commit into from May 25, 2020
Merged

Improve documentation of constants #1330

merged 1 commit into from May 25, 2020

Conversation

ehmicky
Copy link
Contributor

@ehmicky ehmicky commented May 22, 2020

I have seen several bugs in plugins related to not taking into account that some constants:

  • might be undefined
  • might be defined but pointing to a directory that has not been created yet

More background at #1331

This PR tries to improve the documentation there.

@ehmicky ehmicky added documentation Improvements or additions to documentation type: feature code contributing to the implementation of a feature and/or user facing functionality labels May 22, 2020
@ehmicky ehmicky requested a review from verythorough May 22, 2020 12:35
@ehmicky ehmicky self-assigned this May 22, 2020
Copy link
Contributor

@verythorough verythorough left a comment

Choose a reason for hiding this comment

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

Makes sense. Thank you!

@verythorough verythorough merged commit 2629066 into master May 25, 2020
@verythorough verythorough deleted the docs/constants branch May 25, 2020 20:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation type: feature code contributing to the implementation of a feature and/or user facing functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants