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.

Sign up for GitHub

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

Jump to bottom

Document and test missing keywords #1609

Closed
wants to merge 9 commits into from
Closed

Document and test missing keywords #1609

wants to merge 9 commits into from

Conversation

cromedome
Copy link
Contributor

Unsure what I did on #1587, but this is a cleaner version of that PR. Has all the fixes requested in #1587 with one or two extras.

As with #1587:

racke and others added 7 commits March 22, 2021 17:53
@racke @cromedome
Add test to check whether all DSL keywords appear in the manual.
3655fe8
@cromedome
Split DSL keywords to separate man page.
495884f 
This also requires a change in the test to look at the correct doc.
@cromedome
Alphabetize keywords.
e739a23
@cromedome
Add pod for missing keywords.
3bcd2d1
@cromedome
Rename the DSL manual to Keywords.
2ff1b4f 
This should have gone into the Dancer2::Manual namespace to begin
with. It has now been moved there.
@cromedome
Make DSL test point at new doc location.
6d3942e
@cromedome
Use a better style of dereferencing.
9ceb6c1 
The other way, while valid, is ugly and not as readable.
@cromedome cromedome added this to the April 2021 milestone Mar 22, 2021
@cromedome cromedome mentioned this pull request Mar 22, 2021
Closed
@cromedome cromedome modified the milestones: April 2021, May 2021 Apr 15, 2021
bigpresh
bigpresh approved these changes May 12, 2021
View reviewed changes
Copy link
Member

@bigpresh bigpresh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One comment on making the test message clearer for the checks for documented keywords, but otherwise looks good!

t/dsl/pod.t Outdated Show resolved Hide resolved
@cromedome
Copy link
Contributor Author

Merged, thank you. These docs (along with our other docs) could still use improvement, but this is definitely some improvement.

@cromedome cromedome closed this May 12, 2021
@cromedome cromedome deleted the docs/doc-test-missing-keywords branch May 12, 2021 21:17
@cromedome cromedome mentioned this pull request May 12, 2021
Closed
cromedome added a commit that referenced this pull request Jun 3, 2021
@cromedome
v0.301003
817474d 
    [ BUG FIXES ]
    * GH #1611: Redirect '/' doesn't always work as expected (Russell
      @veryrusty Jenkins, Christopher Gurnee)
    * PR #1620: Quiet spammy failing CI builds (Jason A. Crome)
    * PR #1623: Copy Dockerfile from the right spot (Jason A. Crome)

    [ ENHANCEMENTS ]
    * PR #1613: Add git features to Dancer2 CLI (Jason A. Crome)
    * PR #1614: Generate Dockerfile when creating new app (Jason A. Crome)

    [ DOCUMENTATION ]
    * PR #1563: Fix typos in perlcritic.rc notes (Achyut Kumar Panda)
    * PR #1609: Document and test for missing DSL keywords (racke, Jason A.
      Crome)
    * PR #1618: Provide a consistent list of community resources (Jason A.
      Crome)
    * PR #1619: Clarify Dancer2::Template::Simple's role in life (Jason A.
      Crome)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bigpresh bigpresh bigpresh approved these changes

@veryrusty veryrusty Awaiting requested review from veryrusty

@racke racke Awaiting requested review from racke

@SysPete SysPete Awaiting requested review from SysPete

Assignees
No one assigned
Labels
Documentation Enhancement Testing
Projects
None yet
Milestone
May 2021
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@cromedome @bigpresh @racke