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

Package docstring: more peaceful README introduction #56798

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

fonsp
Copy link
Member

@fonsp fonsp commented Dec 11, 2024

Hello! 👋

#39093 is great! This PR styles the banner ("Displaying contents of readme found at ...") differently:

Before:

help?> DifferentialEquations
search: DifferentialEquations

  No docstring found for module DifferentialEquations.

  Exported names
  ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡

  @derivatives, @ode_def, @ode_def_all, @ode_def_bare, 
  ... (manually truncated)

  Displaying contents of readme found at /Users/ian/.julia/packages/DifferentialEquations/HSWeG/README.md
  ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡

  DifferentialEquations.jl
  ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡

  (Image: Join the chat at https://gitter.im/JuliaDiffEq/Lobby) (https://gitter.im/JuliaDiffEq/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) (Image:
  Build Status) (https://github.com/SciML/DifferentialEquations.jl/actions?query=workflow%3ACI) (Image: Stable) (http://diffeq.sciml.ai/stable/) (Image: Dev) (http://diffeq.sciml.ai/dev/)
  (Image: DOI) (https://zenodo.org/badge/latestdoi/58516043)

  This is a suite for numerically solving differential equations written in Julia and available for use in Julia, Python, and R. The purpose of this package is to supply efficient Julia
  implementations of solvers for various differential equations. Equations within the realm of this package include:

    •  Discrete equations (function maps, discrete stochastic (Gillespie/Markov) simulations)

    •  Ordinary differential equations (ODEs)

After:

help?> DifferentialEquations
search: DifferentialEquations

  No docstring found for module DifferentialEquations.

  Exported names
  ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡

  @derivatives, @ode_def, @ode_def_all, @ode_def_bare, 
  ... (manually truncated)

  ────────────────────────────────────────────────────────────────────────────

  Package description from README.md:

  DifferentialEquations.jl
  ≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡≡

  (Image: Join the chat at https://gitter.im/JuliaDiffEq/Lobby) (https://gitter.im/JuliaDiffEq/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) (Image:
  Build Status) (https://github.com/SciML/DifferentialEquations.jl/actions?query=workflow%3ACI) (Image: Stable) (http://diffeq.sciml.ai/stable/) (Image: Dev) (http://diffeq.sciml.ai/dev/)
  (Image: DOI) (https://zenodo.org/badge/latestdoi/58516043)

  This is a suite for numerically solving differential equations written in Julia and available for use in Julia, Python, and R. The purpose of this package is to supply efficient Julia
  implementations of solvers for various differential equations. Equations within the realm of this package include:

    •  Discrete equations (function maps, discrete stochastic (Gillespie/Markov) simulations)

    •  Ordinary differential equations (ODEs)

I think this makes it a bit less technical (the word "Displaying" and the long filename), and it improves the reading flow.

@inkydragon inkydragon added the REPL Julia's REPL (Read Eval Print Loop) label Dec 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
REPL Julia's REPL (Read Eval Print Loop)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants