Skip to content

Condense $FIELDS template #136

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.

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
merged 6 commits into from
Oct 21, 2022
Merged

Conversation

alyst
Copy link
Member

@alyst alyst commented Oct 15, 2022

For $FIELDS/$TYPEDFIELDS templates, put the field description on the same line as the field name.

Example:

  • x::String
  • y::Int: Unlike the x field this field has been documented.
  • z::Array{Any, 1}: Another documented field.

Fixes #63

@MichaelHatherly
Copy link
Member

Thanks, LGTM, looks like we've got some windows test failures.

@alyst
Copy link
Member Author

alyst commented Oct 15, 2022

Thanks, LGTM, looks like we've got some windows test failures.

It looks like the failure is unrelated to the PR. The failed test is for the methods signature formatting. It seems on windows Array{T,3} and Array{T,4} are ordered differently within Union.

@alyst
Copy link
Member Author

alyst commented Oct 16, 2022

Ah, I see that the windows ordering inconsistence is fixed in the recent Julia versions. I've tried to update the tests to make them pass.

Copy link
Member

@MichaelHatherly MichaelHatherly left a comment

Choose a reason for hiding this comment

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

Thanks, I'll tag a patch release once this is merged in.

@alyst
Copy link
Member Author

alyst commented Oct 16, 2022

Thanks, I'll tag a patch release once this is merged in.

Thank you! It looks like v1.8 also behaves differently on Windows, but this time WRT to default function arguments. I will not try to fix this one.
Anyway, it is unrelated to this PR.

@MichaelHatherly MichaelHatherly merged commit 7962ebe into JuliaDocs:master Oct 21, 2022
@alyst alyst deleted the condensed_fields branch October 23, 2022 07:13
alyst added a commit to alyst/DocStringExtensions.jl that referenced this pull request Oct 23, 2022
alyst added a commit to alyst/DocStringExtensions.jl that referenced this pull request Nov 6, 2022
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.

too much white space
2 participants