Skip to content

Commit cdeaef4

Browse files
authored
Merge pull request #1334 from AllenInstitute/feature/1334-add-release-notes
Feature/1334 add release notes
2 parents 134ff2b + 87a9c77 commit cdeaef4

5 files changed

+409
-1
lines changed

Packages/doc/analysis-function-writing.rst

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _File analysis-function-writing.rst:
2+
13
Thirty six hints for writing analysis functions
24
===============================================
35

Packages/doc/developers.rst

+3-1
Original file line numberDiff line numberDiff line change
@@ -78,11 +78,13 @@ data acquisition is blocked.
7878
Cutting a new release
7979
~~~~~~~~~~~~~~~~~~~~~
8080

81-
- Checkout the main branch
81+
- Checkout a new branch ``git checkout -b feature/XXXX-release-notes main``
8282
- Paste the contents of ``Packages\doc\releasenotes_template.rst`` to
8383
the top of ``Packages\doc\releasenotes.rst``
8484
- Call ``tools\create-changelog.sh`` which generate a raw changelog and
8585
fill ``releasenotes.rst`` with a cleaned up version of it.
86+
- Propose a pull request and get it merged
87+
- Checkout the main branch
8688
- Tag the current state with ``git tag Release_X.Y_*``, see ``git tag``
8789
for how the asterisk should look like
8890
- Push the tag: ``git push origin $tag``. You can pass ``--dry-run`` for

Packages/doc/labnotebook-descriptions.rst

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
Labnotebook descriptions
22
========================
33

4+
.. _Table Numerical Labnotebook Description:
5+
46
.. csv-table:: Numerical entries
57
:file: /csv/labnotebook_numerical_description.csv
68
:delim: tab

0 commit comments

Comments
 (0)