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

Workspace inheritance #683

Merged
merged 20 commits into from
Sep 19, 2023
Merged

Conversation

mmagician
Copy link
Member

Description

Based off #556. Weirdly "Maintainers are allowed to edit this pull request.", but: I can make edits to the original PR via the UI (e.g. resolve conflicts), yet not push directly.

@Pratyush I've removed the line you added in ff/lib.rs in b031934, I wasn't able to build with it.

#![doc(html_in_header = include_str!("../../doc/katex-header.html"))]

closes: #556

This PR preserves the original commits and authorship.


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against correct branch (master)
  • Linked to GitHub issue with discussion and accepted design OR have an explanation in the PR that describes this work.
  • Wrote unit tests N/A
  • Updated relevant documentation in the code N/A
  • Added a relevant changelog entry to the Pending section in CHANGELOG.md N/A
  • Re-reviewed Files changed in the GitHub PR explorer

@mmagician mmagician requested review from a team as code owners September 18, 2023 17:08
@mmagician mmagician requested review from z-tech, Pratyush and weikengchen and removed request for a team September 18, 2023 17:08
poly/Cargo.toml Outdated
authors.workspace = true
homepage.workspace = true
repository.workspace = true
keywords.workspace = true
Copy link
Member

Choose a reason for hiding this comment

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

We should use per-crate keywords and categories

Copy link
Member Author

Choose a reason for hiding this comment

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

Good catch 👍🏼

Copy link
Member Author

Choose a reason for hiding this comment

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

We never had categories, but I brought back the old keywords: f01ed68

@Pratyush
Copy link
Member

Does KaTeX get included in the docs for the files? That's what the #![doc(html_in_header = include_str!("../../doc/katex-header.html"))] was trying to achieve, I think?

@mmagician
Copy link
Member Author

At least locally I can some correct display of equations, e.g. in target/doc/ark_ff/fields/trait.Field.html.

That said, I remember there was a difference between local vs actual deployment of docs and how KaTeX was packaged there, so hard to say. I think we can later build a few alpha versions and see, these are handled just as proper releases are in terms of doc deployment, AFAIR.

NB, including that #![doc...] line throws:

error: expected unsuffixed literal or identifier, found `include_str`
  --> ff/src/lib.rs:12:25
   |
12 | #![doc(html_in_header = include_str!("../../doc/katex-header.html"))]

@mmaker
Copy link
Member

mmaker commented Sep 18, 2023

the copy-paste line for docs.rs was

rustdoc-args = [
    "--html-in-header", "doc/katex-header.html",
    "--cfg", "docsrs",
]

but also curious to see if that #![doc...] is sufficient

@Pratyush
Copy link
Member

The #![doc(...)] line didn't work because the macro only accepts literals

@weikengchen weikengchen merged commit 5f588ef into arkworks-rs:master Sep 19, 2023
15 checks passed
aleasims pushed a commit to NilFoundation/arkworks-algebra that referenced this pull request Oct 18, 2023
* Use workspace inheritance for dependencies

* Fix CI: move algebra outside of curves dir

If we clone algebra inside curves, it will look at the curves Cargo.toml
for workspace dependencies. Cloning it outside fixes this.

* Use workspace package for crate information

* Try fix README

* WIP

* remove trailing space

* update crate version numbers to 0.4.2

* bump Rust version

* `algebra` path would overwrite the contents of the parent

change dir to ark-algebra

reference the right filepath in patching step

* clone curves into a separate dir

* update action versions

* remove dir prints

* revert keywords inheritance

---------

Co-authored-by: William Arnold <will748@gmail.com>
Co-authored-by: Weikeng Chen <w.k@berkeley.edu>
Co-authored-by: Pratyush Mishra <pratyushmishra@berkeley.edu>
aleasims added a commit to NilFoundation/arkworks-algebra that referenced this pull request Oct 18, 2023
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.

5 participants