Skip to content

Rename devel to dev #13349

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.

Sign up for GitHub

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

Merged
drammock merged 3 commits into from
Jul 25, 2025
Merged

Rename devel to dev #13349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bb82fe5
Change devel to dev
cbrnr Jul 24, 2025
638516d
Change more occurrences
cbrnr Jul 24, 2025
666cf44
Revert changes to doc/sphinxext/prs
cbrnr Jul 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/check_changelog.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ permissions:

jobs:
changelog_checker:
name: Check towncrier entry in doc/changes/devel/
name: Check towncrier entry in doc/changes/dev/
runs-on: ubuntu-latest
steps:
- uses: scientific-python/action-towncrier-changelog@v1
Expand Down
2 changes: 1 addition & 1 deletion doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ html_dev-noplot: html-noplot
html_dev-front: html-front

linkcheck:
@$(SPHINXBUILD) -b linkcheck -D nitpicky=0 -q -D plot_gallery=0 -D exclude_patterns="cited.rst,whats_new.rst,configure_git.rst,_includes,changes/devel" -d _build/doctrees . _build/linkcheck
@$(SPHINXBUILD) -b linkcheck -D nitpicky=0 -q -D plot_gallery=0 -D exclude_patterns="cited.rst,whats_new.rst,configure_git.rst,_includes,changes/dev" -d _build/doctrees . _build/linkcheck

doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest
Expand Down
2 changes: 1 addition & 1 deletion doc/_static/versions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[
{
"name": "1.11 (devel)",
"name": "1.11 (dev)",
Copy link
Copy Markdown
Member

@drammock drammock Jul 24, 2025

Choose a reason for hiding this comment

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

-1 on changing the changelog folder name. It's not user-facing. This change is the only one I expected you to make.

Copy link
Copy Markdown
Contributor Author

@cbrnr cbrnr Jul 24, 2025

Choose a reason for hiding this comment

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

OK, but why not be consistent even for devs? Do you expect any problems if we change it?

Copy link
Copy Markdown
Member

@drammock drammock Jul 24, 2025

Choose a reason for hiding this comment

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

I don't foresee specific problems, but that doesn't guarantee there won't be any. To me, the effort & risk of unforeseen problems far outweigh the gain here. If you insist on changing the foldername, then we (you) should also do a .git-blame-ignore-revs entry for that change (which, ideally, means separating it from the change to the versions.json file).

Copy link
Copy Markdown
Contributor Author

@cbrnr cbrnr Jul 24, 2025

Choose a reason for hiding this comment

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

As @larsoner noted, I've reverted changes to the history files in doc/sphinxext/prs, so now I think the remaining changes are small and also should not require a .git-blame-ignore-revs entry.

"version": "dev",
"url": "https://mne.tools/dev/"
},
Expand Down
0 doc/changes/devel.rst → doc/changes/dev.rst
View file
Open in desktop
File renamed without changes.
0 doc/changes/devel.rst.template → doc/changes/dev.rst.template
View file
Open in desktop
File renamed without changes.
0 doc/changes/devel/.gitignore → doc/changes/dev/.gitignore
View file
Open in desktop
File renamed without changes.
0 doc/changes/devel/13112.bugfix.rst → doc/changes/dev/13112.bugfix.rst
View file
Open in desktop
File renamed without changes.
0 doc/changes/devel/13259.newfeature.rst → doc/changes/dev/13259.newfeature.rst
View file
Open in desktop
File renamed without changes.
0 doc/changes/devel/13341.bugfix.rst → doc/changes/dev/13341.bugfix.rst
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@
# This pattern also affects html_static_path and html_extra_path.

# NB: changes here should also be made to the linkcheck target in the Makefile
exclude_patterns = ["_includes", "changes/devel"]
exclude_patterns = ["_includes", "changes/dev"]

# The suffix of source filenames.
source_suffix = ".rst"
Expand Down
4 changes: 2 additions & 2 deletions doc/development/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -597,7 +597,7 @@ skipped for very minor changes like correcting typos in the documentation.

There are six separate sections for changes, based on change type.
To add a changelog entry to a given section, name it as
:file:`doc/changes/devel/<PR-number>.<type>.rst`. The types are:
:file:`doc/changes/dev/<PR-number>.<type>.rst`. The types are:

notable
For overarching changes, e.g., adding type hints package-wide. These are rare.
Expand All @@ -615,7 +615,7 @@ other
internal refactorings.

For example, for an enhancement PR with number 12345, the changelog entry should be
added as a new file :file:`doc/changes/devel/12345.enhancement.rst`. The file should
added as a new file :file:`doc/changes/dev/12345.enhancement.rst`. The file should
contain:

1. A brief description of the change, typically in a single line of one or two
Expand Down
2 changes: 1 addition & 1 deletion doc/development/whats_new.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Changes for each version of MNE-Python are listed below.
.. toctree::
:maxdepth: 1

../changes/devel.rst
../changes/dev.rst
../changes/v1.10.rst
../changes/v1.9.rst
../changes/v1.8.rst
Expand Down
2 changes: 1 addition & 1 deletion doc/sphinxext/credit_tools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ def generate_credit_rst(app=None, *, verbose=False):
mne/_version.py mne/externals/* */__init__.py* */resources.py paper.bib
mne/html/*.css mne/html/*.js mne/io/bti/tests/data/* */SHA1SUMS *__init__py
AUTHORS.rst CITATION.cff CONTRIBUTING.rst codemeta.json mne/tests/*.* jr-tools
*/whats_new.rst */latest.inc */devel.rst */changelog.rst */manual/* doc/*.json
*/whats_new.rst */latest.inc */dev.rst */changelog.rst */manual/* doc/*.json
logo/LICENSE doc/credit.rst
""".strip().split():
globs[key] = "null"
Expand Down
2 changes: 1 addition & 1 deletion mne/utils/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -983,7 +983,7 @@ def _check_mne_version(timeout):
rel_ver = parse(rel_ver)
this_ver = parse(import_module("mne").__version__)
if this_ver > rel_ver:
return True, f"devel, latest release is {rel_ver}"
return True, f"development, latest release is {rel_ver}"
if this_ver == rel_ver:
return True, "latest release"
else:
Expand Down
4 changes: 2 additions & 2 deletions mne/utils/tests/test_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,12 +231,12 @@ def bad_open(url, timeout, msg):
out = out.getvalue()
assert " 1.5.1 (latest release)" in out

# Devel
# Development version
monkeypatch.setattr(mne, "__version__", "1.6.dev0")
out = ClosingStringIO()
sys_info(fid=out)
out = out.getvalue()
assert "devel, " in out
assert "development, " in out
assert "updating.html" not in out


Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,8 +378,8 @@ spaces_before_inline_comment = 2
trailing_comma_inline_array = true

[tool.towncrier]
directory = "doc/changes/devel/"
filename = "doc/changes/devel.rst"
directory = "doc/changes/dev/"
filename = "doc/changes/dev.rst"
issue_format = "`#{issue} <https://github.com/mne-tools/mne-python/pull/{issue}>`__"
package = "mne"
title_format = "{version} ({project_date})"
Expand Down
Loading