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

Improve Parse and Format docs #1727

Merged
merged 4 commits into from Jan 5, 2018

Conversation

Projects
None yet
1 participant
@ricardograca
Member

ricardograca commented Jan 5, 2018

Introduction

Finishes the work started by @tbug in the PR linked above that was never updated to reflect the proposed changes and address the comments of the reviewers.

Also adds some text to address a few concerns raised in issue #668.

Fixes #1671, closes #1040.

Motivation

These methods are a bit confusing and it's not easy for a newcomer to know that they are complementary and which one does the opposite operation of the other. The issue tracker has a few questions related with this.

Proposed solution

A simple link to the opposite operation inside the docs of both Parse and Format.

Also adds a new Tutorials section to the main documentation where the only available guide right now is the Parse and Format document.

Current PR Issues

Doesn't really address all the concerns of issue #668, since that requires a lot more work and some changes.

ricardograca added some commits Jan 3, 2018

Add links to and from parse() and format()
- Also adds a warning about the potential shortcomings of format(),
derived from issue #668.

@ricardograca ricardograca merged commit 435c764 into master Jan 5, 2018

0 of 2 checks passed

continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
continuous-integration/travis-ci/push The Travis CI build is in progress
Details

@ricardograca ricardograca deleted the rg-improve-docs branch Jan 5, 2018

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