Skip to content

(WIP) Generate field description rather than docstring#54

Open
devxoul wants to merge 1 commit intojhnnsrs:mainfrom
devxoul:field-description
Open

(WIP) Generate field description rather than docstring#54
devxoul wants to merge 1 commit intojhnnsrs:mainfrom
devxoul:field-description

Conversation

@devxoul
Copy link
Copy Markdown
Contributor

@devxoul devxoul commented Mar 13, 2023

This PR resolves #53

I couldn't find a related test case and I'm not sure whether this change could cause side effects.

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 13, 2023

Codecov Report

Patch coverage: 100.00% and project coverage change: -0.01 ⚠️

Comparison is base (5b78fa2) 93.88% compared to head (2c74c54) 93.88%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master      #54      +/-   ##
==========================================
- Coverage   93.88%   93.88%   -0.01%     
==========================================
  Files          56       56              
  Lines        3058     3056       -2     
==========================================
- Hits         2871     2869       -2     
  Misses        187      187              
Impacted Files Coverage Δ
turms/recurse.py 87.80% <100.00%> (-0.15%) ⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@jhnnsrs
Copy link
Copy Markdown
Owner

jhnnsrs commented Mar 13, 2023

Hi there thanks for the PR :)

Tests seem to like it, however i think it would be great if this could be a bit more configurable, as some people (me for example might prefer the docstring over the description). What would you think about adding a Generator Config variable with
field_description = "docstring" | "inline" | "both" ?

@devxoul
Copy link
Copy Markdown
Contributor Author

devxoul commented Mar 14, 2023

@jhnnsrs that would be awesome. I think I can update the PR this month.

@devxoul devxoul changed the title Generate field description rather than docstring (WIP) Generate field description rather than docstring Mar 14, 2023
@devxoul devxoul marked this pull request as draft March 14, 2023 12:59
@jhnnsrs jhnnsrs marked this pull request as ready for review March 23, 2023 23:13
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.

Generate field description rather than docstring in FragmentsPlugin?

2 participants