Repository navigation
Add dev docs explaining PLY integration #4318
Description
As mentioned in #4300, there are some pieces of units and coordinates that use PLY (and lex/yacc) to parse various strings. However, there is no developer documentation describing how this works and how it should be maintained. It would be valuable if @mdboom (or perhaps @embray ?) could write a short developer docs page describing how these fit together, so that other contributors can understand how they might be able to help maintain or expand these pieces.
Activity
[-]Add dev docs explaining [/-][+]Add dev docs explaining PLY integration[/+]embray commentedon Nov 17, 2015
I think the documentation for PLY itself would be a start...
These modules are just using PLY in a way that is not unusual.
eteq commentedon Nov 18, 2015
@embray - the point is why they are used and specifically where, and how/when to invoke it. Even if it's standard, the point is that most people who may need to fiddle with these things don't have the time/inclination to master PLY so there should be some information about why they should care and how to get started learning what they need to o know.
embray commentedon Nov 18, 2015
In the relatively remote chance any has to, they should start here:
http://www.dabeaz.com/ply/ply.html
There's not much point in reiterating what the PLY docs already say. It's pretty succinct already, and anybody who's going to mess with a parser should understand how that works. Those docs tell you everything you need to know. I don't think there's anything too special to know about its use in astropy beyond what you already added in those comments.
AMAN3003 commentedon Feb 7, 2016
@eteq could I work on this
AMAN3003 commentedon Feb 7, 2016
@eteq @embray please guide me what should i do to write the dev ply docs
astrofrog commentedon Feb 7, 2016
@AMAN3003 - this issue is labelled as
package-expert, which means that it requires a lot of knowledge about how we've set up the package, etc. So this issue is more intended as an issue for a core developer. I would suggest sticking topackage-noviceissues for now while you familiarize yourself with the project.AMAN3003 commentedon Feb 7, 2016
@astrofrog thank you for you advice.But could you give me a favour ..please include me in development team by assigning little task .I would do my best .I want to develop with your teams.Developing little function of the scripts will also be a golden chance for me.Give me a chance Sir
eteq commentedon Feb 9, 2018
Closed by #7174