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

Implement function to list data files #589

Merged
merged 1 commit into from
Nov 2, 2019

Conversation

CyberDrudge
Copy link
Contributor

Fixes #586

Function cantera.data.files() returns list of all data files. It can also be used to get files of a certain type by specifying the required extension.

Copy link
Member

@bryanwweber bryanwweber 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 sending this change! A few changes to request. When you make them, please squash all of your changes into one commit and force push to this branch to update the pull request.

interfaces/cython/cantera/data/__init__.py Outdated Show resolved Hide resolved
interfaces/cython/cantera/data/__init__.py Outdated Show resolved Hide resolved
@bryanwweber
Copy link
Member

@CyberDrudge Thank you for the quick fixes! Can you squash the three commits here into one commit and force-push to this branch? If you need help with that, just let me know 😄 Thanks!

@CyberDrudge
Copy link
Contributor Author

@bryanwweber no worries, a bit of googling showed me the way.

@bryanwweber
Copy link
Member

bryanwweber commented Feb 1, 2019

@speth The function here is named files. I'm not totally sure that's the best name for this API, I wonder if list_files or list_data_files or print_data_files or something else would be better?

@CyberDrudge Can you please add documentation to this function? It would look something like

def files(ext=''):
    """
    Overall description of what this function does.

    :param ext:
        Description of what the ext argument does
    """

Thanks!

@CyberDrudge
Copy link
Contributor Author

Changed function name and added Documentation. I will edit name and squash changes if required.

Update function to list data files

Follow Style Guidelines

Add doc for listing files
@CyberDrudge
Copy link
Contributor Author

@bryanwweber does this still require any updates before it gets merged?

@bryanwweber bryanwweber self-requested a review November 2, 2019 02:18
@bryanwweber bryanwweber merged commit 65f7b16 into Cantera:master Nov 2, 2019
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.

Provide a summary of data files from the Python interface
2 participants