Skip to content

Streamline Website and Documentation Style #9

@DunklesArchipel

Description

@DunklesArchipel

Thanks. Looks great.

I just had some style suggestions.

I wonder if we should streamline our style of communication (probably we should have a style guide.) Currently, we have a mix of "one can create", "you can create", "we can create", "something can be created". Maybe we should settle for some style and just use it everywhere. (Probably, whatever Python's documentation does?)

Similarly, I wonder if we should replace some of our links with a simpler "→ Learn more" or something like that. Currently, we also tend to write (overexagerating here) somewhat convoluted "if you would like to see more examples of blablabla, you might want to click on this link"

Should I create an issue?

Originally posted by @saraedum in echemdb/echemdb#35 (review)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions