Skip to content
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

[WIP] Fix updating annotation when formatted for Yard docs #781

Closed
wants to merge 2 commits into from

Conversation

tmr08c
Copy link
Contributor

@tmr08c tmr08c commented Mar 22, 2020

This is a WIP attempt to resolve #780

I'd be interested in feedback on the direction of the approach.

TODO:

  • Additional tests for updating Yard docs
    • With Yard docs, the indexes are formatted differently
    • Testing column changes
    • Trying to more robustly test the regular expression
  • Add similar support for RDoc syntax

The lgoic in `AnnotateModels.annotate_one_file` for determining whether
there were changes a class' list of columns relied on a `column_pattern`
regular expression to fetch the list of columns in the annotation.

This regular expression was hard-coded to match on the original, default
"bare" syntax. If using an alternative documentation format (e.g.,
Yard), this regular expression would fail to find the columns and not
attempt to update the class' annoations.

This adds an additional regular expression to search for Yard-formatted
documentation.
@tmr08c tmr08c closed this Mar 24, 2020
@tmr08c
Copy link
Contributor Author

tmr08c commented Mar 24, 2020

Closed in favor of #784 to leverage GitHub's Draft PR feature.

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.

Yard doc style annotations do not update after migrations
1 participant