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

Add revised information to prawn manual #545

Closed
tomciopp opened this issue Sep 6, 2013 · 7 comments
Closed

Add revised information to prawn manual #545

tomciopp opened this issue Sep 6, 2013 · 7 comments

Comments

@tomciopp
Copy link

tomciopp commented Sep 6, 2013

Can you add revision data to the beginning of the prawn manual? I have been running into a lot of inconsistencies between the api of the manual and errors in prawn, and I am unsure whether it is due to me not tracking the most recent development branch or regressions in the gem. Something like:

Last Updated: September 6th 2013,
Prawn Version: 1.0.0.rc2
Sha1: "blahblahblah"

@sockmonk
Copy link

+1 for this suggestion. It might also be nice to have a version for at least the last officially stable release, which at this point I think was 0.12.0, simply because some people like to stick with stable versions. In the meantime, I'd suggest browsing the source of whichever version you're using to see what the actual api looks like for that version.

@practicingruby
Copy link
Member

This is a nice idea. @ciopte7 or anyone else who is interested, please prepare a pull request with a patch.

Closing this ticket, because we can't reasonably track feature requests for anything non-critical with our current backlog. But a patch is welcome!

practicingruby added a commit that referenced this issue Nov 19, 2013
Adding revision information to manual (issue #545)
@boutil
Copy link
Contributor

boutil commented Mar 7, 2014

Hi!
A test for a .git directory should probably added, since this would fail if the source is not obtained from a Git repository (but from the gem or a source package from a Linux distribution)

@practicingruby
Copy link
Member

@boutil Good idea. Please submit a pull request.

@boutil
Copy link
Contributor

boutil commented Mar 9, 2014

@sandal, I just pushed a proposition to the branch manual-cover-git.

@practicingruby
Copy link
Member

@boutil: Thanks, can you open a pull request for that branch so that we can discuss there?

@boutil
Copy link
Contributor

boutil commented Mar 9, 2014

@sandal, this is pull request #691.

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

No branches or pull requests

4 participants