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 ref to regex pattern that matches proc signature for formatting #68

Merged
merged 2 commits into from
Dec 6, 2022

Conversation

arezaii
Copy link
Contributor

@arezaii arezaii commented Dec 6, 2022

This PR adds pattern matching for proc ref name(args) where previously
the ref this intent would cause sphinx to not format the proc the
same as others, and also not generate a permalink for the signature.

TESTING:

  • hyperlink and correct format for signatures with ref this intent
  • dif the new docs with the old docs

reviewed by @lydia-duncan - thanks!

Signed-off-by: arezaii ahmad.rezaii@hpe.com

@arezaii arezaii force-pushed the fix-proc-ref-links branch 2 times, most recently from c08a4f5 to 5695b2a Compare December 6, 2022 21:41
Signed-off-by: arezaii <ahmad.rezaii@hpe.com>
@arezaii arezaii force-pushed the fix-proc-ref-links branch from 5695b2a to aa34310 Compare December 6, 2022 21:43
@codecov
Copy link

codecov bot commented Dec 6, 2022

Codecov Report

Base: 42.96% // Head: 42.96% // No change to project coverage 👍

Coverage data is based on head (2cf34d1) compared to base (ba9de5d).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #68   +/-   ##
=======================================
  Coverage   42.96%   42.96%           
=======================================
  Files           2        2           
  Lines         533      533           
=======================================
  Hits          229      229           
  Misses        304      304           
Impacted Files Coverage Δ
sphinxcontrib/chapeldomain/__init__.py 41.19% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

Signed-off-by: arezaii <ahmad.rezaii@hpe.com>
@arezaii arezaii marked this pull request as ready for review December 6, 2022 21:59
Copy link
Member

@lydia-duncan lydia-duncan left a comment

Choose a reason for hiding this comment

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

This looks good to me

@arezaii
Copy link
Contributor Author

arezaii commented Dec 6, 2022

performing the dif found new links for:
ChapelDomain.add
Set.add
SortedSet.add
List.append
UnrolledLinkedList.append
ChapelDomain.bulkAdd
ChapelDomain.clear
List.clear
OwnedObject.clear
Set.clear
SortedSet.clear
UnrolledLinkedList.clear
Socket.tcpListener.close
List.extend
UnrolledLinkedList.extend
LinkedList.first
List.first
UnrolledLinkedList.first
List.insert
UnrolledLinkedList.insert
LinkedList.last
List.last
UnrolledLinkedList.last
List.pop
UnrolledLinkedList.pop
OwnedObject.release
ChapelDomain.remove
List.remove
Set.remove
SortedSet.remove
UnrolledLinkedList.remove
ChapelDomain.requestCapacity
OwnedObject.retain
SharedObject.retain
List.set
Socket.tcpListener.setDelayAck
Socket.tcpConn.setNagle
Socket.tcpListener.setNagle
List.sort
Ctypes.c_array.this
List.this
Map.this
SortedMap.this
UnrolledLinkedList.this
ChapelDomain.unsafeAssign

@arezaii arezaii merged commit 80ca04f into chapel-lang:main Dec 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants