Skip to content

remove processing of docstrings#45

Merged
R Sharp (r-sharp) merged 1 commit intomainfrom
fix_doctrings
Dec 17, 2024
Merged

remove processing of docstrings#45
R Sharp (r-sharp) merged 1 commit intomainfrom
fix_doctrings

Conversation

@james-bruten-mo
Copy link
Collaborator

@james-bruten-mo James Bruten (james-bruten-mo) commented Dec 16, 2024

One request from the reviewer meeting was to have a template docstring to describe what a macro is doing.
At the moment the script removes docstrings from the macros - this was done to aid development of the script, but it would be better practice to not remove them now.
This PR will remove the parsing of docstrings from the script.

Copy link
Contributor

Choose a reason for hiding this comment

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

All looks good.

One comment on code formatting but doesn't effect functionality.

Copy link
Contributor

@r-sharp R Sharp (r-sharp) left a comment

Choose a reason for hiding this comment

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

I requested some tweaks to the PR text itself (in conversation with James). I would also re-iterate Cameron's comment, but Black is Black and we will be assimilated.
Otherwise the change looks good to me.

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.

3 participants