Add Python syntax highlighting to `README.rst`#395

Merged

altendky merged 1 commit intopythonprofilers:masterfrom

Benjamin-Loison:master

Oct 23, 2023

Contributor

Benjamin-Loison commented Oct 22, 2023

Verified exhaustiveness with:

find -name '*.rst'


          Add Python syntax highlighting to README.rst

864e9f4

Verified exhaustiveness with:

```bash
find -name '*.rst'
```

altendky reviewed

View reviewed changes

Collaborator

altendky left a comment

Thanks for an easy review! And the improvements. :] What do you think of using python-console for those blocks as in the suggestions?

README.rst

-              args, kw)``. For example::
+              args, kw)``. For example:
+              .. code-block:: python

Collaborator

altendky Oct 22, 2023

Suggested change

      
            .. code-block:: python
          
            .. code-block:: python-console

README.rst

               The output can be redirected to a log file by passing IO stream as
               parameter to the decorator like @profile(stream=fp)
+              .. code-block:: python

Collaborator

altendky Oct 22, 2023

Suggested change

      
            .. code-block:: python
          
            .. code-block:: python-console

README.rst

               The output can be redirected to logger module by simply making use of
               LogFile of memory profiler module.
+              .. code-block:: python

Collaborator

altendky Oct 22, 2023

Suggested change

      
            .. code-block:: python
          
            .. code-block:: python-console

README.rst

               by passing True to reportIncrementFlag, where reportIncrementFlag is
               a parameter to LogFile class of memory profiler module.
+              .. code-block:: python

Collaborator

altendky Oct 22, 2023

Suggested change

      
            .. code-block:: python
          
            .. code-block:: python-console

README.rst


		and is exposed by the API

		.. code-block:: python

Collaborator

altendky Oct 22, 2023

Suggested change

      
            .. code-block:: python
          
            .. code-block:: python-console

README.rst

               be evaluated or a tuple ``(f, args, kw)`` containing a function and its
               arguments to be evaluated as ``f(*args, **kw)``. For example,
+              .. code-block:: python

Collaborator

altendky Oct 22, 2023

Suggested change

      
            .. code-block:: python
          
            .. code-block:: python-console

Contributor Author

Benjamin-Loison commented Oct 22, 2023 •

edited

Loading

Thank you for suggesting using Python console syntax highlighting, I like the idea of using it to be more precise. However, as this code snippet shows in the Preview tab, it has a syntax highlighting for the indented code (by precising Python syntax highlighting), but not when using Python console syntax highlighting. Without even talking about the rendering in the Code tab which doesn't work at all for Python console syntax highlighting.

So Python console GitHub syntax highlighting rendering doesn't seem perfect yet, hence I don't have any strong opinion and I let you choose the one you prefer.

Benjamin-Loison requested a review from altendky

October 22, 2023 17:13

altendky approved these changes

View reviewed changes

Collaborator

altendky left a comment

Always something, isn't it... Oh well.

altendky merged commit a99a3c3 into pythonprofilers:master

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet