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

Fix keep docs dir #89

Merged
merged 2 commits into from
Mar 29, 2023
Merged

Fix keep docs dir #89

merged 2 commits into from
Mar 29, 2023

Conversation

Sebastian-0
Copy link
Contributor

This will change the behaviour of keep_docs_dir for DocsRepo as follows:

  • There are three states for keep_docs_dir: True, False and None.
    • When set to None the global setting is used instead, this is now the default
    • When set to True or False it will override the global setting

Previously keep_docs_dir was always false and the global setting was always ignored (regardless of whether or not keep_docs_dir was true or false).

I also added parameterized as a test dependency so that I could parameterize test_keep_docs_dir and test all permutations of local vs. global keep_docs_dir values.

@github-actions
Copy link

github-actions bot commented Mar 27, 2023

Version Number Check

Update the version in pyproject.toml if you want this PR to generate a new release (main is 0.6.0 >= 0.6.0).

Previously this value didn't matter, only the setting on each import had
an effect. Now we use the global value (False by default) unless a
repo overrides the value with either True or False.
Now we test all possible combinations of settings instead
@Sebastian-0
Copy link
Contributor Author

@jdoiro3 I added my change to the changelog under v0.6.1 but didn't increment plugin version since this is a small fix, and I also have my other PR (#86) which could go under the same version (I also pushed an updated changelog in that one).

Is there anything else you want me to do?

@jdoiro3 jdoiro3 merged commit bec2b1f into jdoiro3:main Mar 29, 2023
@jdoiro3
Copy link
Owner

jdoiro3 commented Mar 29, 2023

@Sebastian-0, I can handle the rest. Thanks for contributing and improving the plugin. I appreciate it!

@Sebastian-0 Sebastian-0 deleted the fix-keep-docs-dir branch June 24, 2024 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants