Skip to content
This repository was archived by the owner on Aug 11, 2023. It is now read-only.

Narrative doc for new enable_deprecations_as_exceptions() options - #259

Merged
bsipocz merged 2 commits into
astropy:cookiecutterfrom
pllim:deprec-cfg-doc
Jun 16, 2017
Merged

bsipocz merged 2 commits into
astropy:cookiecutterfrom
pllim:deprec-cfg-doc

Conversation

@pllim

@pllim pllim commented Jun 16, 2017

Copy link
Copy Markdown
Member

Narrative doc for astropy/astropy#6223

@pllim

pllim commented Jun 16, 2017

Copy link
Copy Markdown
Member Author

Um... Is master the right branch now? I see there is also a "cookie cutter" branch.

@pllim
pllim changed the base branch from master to cookiecutter June 16, 2017 00:48
@pllim
pllim changed the base branch from cookiecutter to master June 16, 2017 00:48
@bsipocz

bsipocz commented Jun 16, 2017

Copy link
Copy Markdown
Member

Nope, cookiecutter branch is the one we supposed to do any development. "master" is the legacy branch, and rendered is the rendered cookiecutter one.

@bsipocz

bsipocz commented Jun 16, 2017

Copy link
Copy Markdown
Member

Although, I think we still have all the affiliated docs in astropy core.

@bsipocz
bsipocz changed the base branch from master to cookiecutter June 16, 2017 00:53
@pllim

pllim commented Jun 16, 2017

Copy link
Copy Markdown
Member Author

In the affiliated doc in the core, it says, "The package template has comments in the conftest.py file that indicate what they are."

I'll resolve the conflicts here then.

@bsipocz

bsipocz commented Jun 16, 2017

Copy link
Copy Markdown
Member

@pllim - I've changed your based branch, but sadly it didn't automatically realized that your changes should apply to ``{{ cookiecutter.package_name }}/{{ cookiecutter.module_name }}/conftest.py

@pllim

pllim commented Jun 16, 2017

Copy link
Copy Markdown
Member Author

Rebased to the right "upstream".

## exceptions. For Astropy v2.0 or later, there are 2 additional keywords,
## as follow.
## To ignore some modules that produce deprecation warnings on import, add:
## modules_to_ignore_on_import=['module_1', 'module_2']

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

aren't these packages rather than modules? maybe list the ones that are currently ignored.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I guess you are right as far as user is concerned although technically it can be either package or module. Sure, I'll list them.

@bsipocz

bsipocz commented Jun 16, 2017

Copy link
Copy Markdown
Member

Thanks, this looks good to me.

@bsipocz
bsipocz merged commit fb96448 into astropy:cookiecutter Jun 16, 2017
@pllim
pllim deleted the deprec-cfg-doc branch June 16, 2017 01:18
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants