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

export v2: footer description option #423

Merged
merged 7 commits into from
Dec 13, 2019
Merged

export v2: footer description option #423

merged 7 commits into from
Dec 13, 2019

Conversation

joverlee521
Copy link
Contributor

For export v2 add a --description option that takes a Markdown file and adds the text to the JSON in meta.description.

This PR is dependent on nextstrain/auspice#834 to render the footer text in Auspice.

Allows users to point to a Markdown file that contains description
to display in the Auspice footer.
Copy link
Member

@jameshadfield jameshadfield left a comment

Choose a reason for hiding this comment

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

This looks good @joverlee521, thanks! Please add a test build (e.g. fa98bb2 or similar) which uses a custom description/footer.

augur/export_v2.py Outdated Show resolved Hide resolved
@emmahodcroft
Copy link
Member

Can we update the documentation/migration guide as well? I suppose it's not officially part of v6 perhaps but this is the best description of all the export options we have, and even I find it useful as there are lots to remember...!

Raise fatal error if the provided description file does not exist.
augur/export_v2.py Outdated Show resolved Hide resolved
augur/export_v2.py Outdated Show resolved Hide resolved
augur/export_v2.py Outdated Show resolved Hide resolved
Copy link
Member

@trvrb trvrb left a comment

Choose a reason for hiding this comment

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

I accidentally typed in review of nextstrain/auspice#834 here.

@tsibley tsibley self-requested a review December 13, 2019 17:40
Copy link
Member

@tsibley tsibley left a comment

Choose a reason for hiding this comment

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

Thanks for addressing my comments, this looks good!

@trvrb trvrb deleted the export-footer branch December 13, 2019 22:21
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.

6 participants