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

Indentations being ignored on show #92

Closed
eliorc opened this issue Jan 9, 2020 · 1 comment
Closed

Indentations being ignored on show #92

eliorc opened this issue Jan 9, 2020 · 1 comment
Assignees
Labels
enhancement willfix

Comments

@eliorc
Copy link

eliorc commented Jan 9, 2020

When documenting classes or methods there are some common formats, like NumPy, Google and the standard reStructuredText format - all which involve indentations.

When using the show command line argument, these indentations are being ignored

Example:

train_benchmark.py

from metaflow import FlowSpec, step


class TrainBenchmarkModelFlow(FlowSpec):
    """
    Train a benchmark model

    Example
    -------

    Train a benchmark model

    .. code-block:: bash

        python train_benchmark.py run
    """
    ...

if __name__ == '__main__':
    TrainBenchmarkModelFlow()

Running python train_benchmark.py show results in

Metaflow 2.0.1 executing TrainBenchmarkModelFlow ...

Train a benchmark model

Example
-------

Train a benchmark model

.. code-block:: bash

python train_benchmark.py run

Notice in the output the indentation is ignored. It will be helpful to have the correct indentation for better readability

@romain-intel romain-intel added the enhancement label Jan 9, 2020
@romain-intel
Copy link
Contributor

romain-intel commented Jan 9, 2020

Thanks for the suggestion, we will look into it.

@romain-intel romain-intel added the willfix label Feb 23, 2020
romain-intel added a commit that referenced this issue Mar 6, 2020
1. Use a smaller standalone Conda installer for AWS Batch
2. Add METAFLOW_S3_ENDPOINT_URL configuration (#130)
3. Use the CLI datastore-root before checking for METAFLOW_DATASTORE_SYSROOT_S3
4. Fix an issue where using the local metadata provider with Batch resulted
   in .metaflow/.metaflow instead of just .metaflow
5. Add a way to get parameter names passed to a flow (using
   current.parameter_names) (#137)
6. Properly indent on show (#92)
7. Surpress superfluous message when running on Batch
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement willfix
Projects
None yet
Development

No branches or pull requests

2 participants